Files
templates/hdl/scope-acquisition/include/scope_regs.h
T

85 lines
3.0 KiB
C

#ifndef SCOPE_REGS_H
#define SCOPE_REGS_H
#include <stdint.h>
/* Register ABI v1: four-channel ADC + bounded BRAM acquisition.
* No DMA/DDR, calibration, interleave or DIO register ABI is implemented. */
#define SCOPE_EXPECTED_ID UINT32_C(0x53434f50)
#define SCOPE_ABI_VERSION UINT32_C(0x00010000)
#define SCOPE_DEFAULT_REFERENCE_RATE_HZ UINT32_C(100000000)
#define SCOPE_DEFAULT_CAPTURE_DEPTH UINT32_C(256)
#define SCOPE_FIXED_CHANNEL_ENABLE UINT32_C(0x0000000f)
enum scope_register_offset {
SCOPE_REG_ID = 0x00,
SCOPE_REG_VERSION = 0x04,
SCOPE_REG_CONTROL = 0x08,
SCOPE_REG_STATUS = 0x0c,
SCOPE_REG_REFERENCE_RATE_HZ = 0x10,
SCOPE_REG_CHANNEL_ENABLE = 0x14,
SCOPE_REG_CAPABILITIES = 0x18,
SCOPE_REG_DEPTH = 0x1c,
SCOPE_REG_TRIGGER_SOURCE = 0x20,
SCOPE_REG_TRIGGER_LEVEL = 0x24,
SCOPE_REG_TRIGGER_MODE = 0x28,
SCOPE_REG_TRIGGER_EDGE = 0x2c,
SCOPE_REG_PRE = 0x30,
SCOPE_REG_POST = 0x34,
SCOPE_REG_HYSTERESIS = 0x38,
SCOPE_REG_AUTO_TIMEOUT = 0x3c,
SCOPE_REG_TRIGGER_INDEX_LO = 0x50,
SCOPE_REG_TRIGGER_INDEX_HI = 0x54,
SCOPE_REG_FIRST_INDEX_LO = 0x58,
SCOPE_REG_FIRST_INDEX_HI = 0x5c,
SCOPE_REG_RECORD_LENGTH = 0x60,
SCOPE_REG_SNAPSHOT_STATUS = 0x64,
SCOPE_REG_SAMPLE_COUNT_LO = 0x68,
SCOPE_REG_SAMPLE_COUNT_HI = 0x6c,
SCOPE_REG_FIFO1_OVERFLOW = 0x70,
SCOPE_REG_FIFO2_OVERFLOW = 0x74,
SCOPE_REG_TRIGGER_COUNT = 0x78
};
/* Write exactly one command, then await the write response. Zero is a no-op. */
#define SCOPE_CONTROL_ARM UINT32_C(0x00000001)
#define SCOPE_CONTROL_STOP UINT32_C(0x00000002)
#define SCOPE_CONTROL_SOFT_RESET UINT32_C(0x00000004)
#define SCOPE_CONTROL_SNAPSHOT UINT32_C(0x00000008)
#define SCOPE_CAP_ADC4 UINT32_C(0x00000001)
#define SCOPE_CAP_BRAM_CAPTURE UINT32_C(0x00000002)
#define SCOPE_CAP_EXTERNAL_EPOCH UINT32_C(0x00000004)
#define SCOPE_CAPABILITIES_V1 UINT32_C(0x00000007)
/* scope_core STATUS/SNAPSHOT_STATUS bits; all other bits are reserved zero. */
#define SCOPE_STATUS_ACTIVE UINT32_C(0x00000001)
#define SCOPE_STATUS_DONE UINT32_C(0x00000002)
#define SCOPE_STATUS_FAULT UINT32_C(0x00000004)
#define SCOPE_STATUS_EPOCH_VALID UINT32_C(0x00000008)
#define SCOPE_STATUS_STREAM_VALID UINT32_C(0x00000010)
#define SCOPE_STATUS_FRONTEND_FAULT UINT32_C(0x00000020)
#define SCOPE_STATUS_CORE_RESET UINT32_C(0x00000040)
enum scope_trigger_source {
SCOPE_TRIGGER_CH1 = 0,
SCOPE_TRIGGER_CH2 = 1,
SCOPE_TRIGGER_CH3 = 2,
SCOPE_TRIGGER_CH4 = 3,
SCOPE_TRIGGER_EXTERNAL = 4
};
enum scope_trigger_mode {
SCOPE_TRIGGER_AUTO = 0,
SCOPE_TRIGGER_NORMAL = 1,
SCOPE_TRIGGER_SINGLE = 2
};
enum scope_trigger_edge {
SCOPE_TRIGGER_RISING = 0,
SCOPE_TRIGGER_FALLING = 1
};
/* These constants are defaults, not substitutes for capability/depth queries.
* 64-bit counters/indices are read only from the completed SNAPSHOT bank.
* Platform code supplies MMIO accessors, barriers and the peripheral base. */
#endif