pluto_hdl_adi/docs/regmap/adi_regmap_pwm_gen.txt

TITLE
PWM Generator (axi_pwm_gen)
axi_pwm_gen
ENDTITLE

############################################################################################
############################################################################################

REG
0x0000
REG_VERSION
Version and Scratch Registers
ENDREG

FIELD
[31:0] 0x00010100
VERSION[31:0]
RO
Version number. Unique to all cores.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0001
REG_ID
Core ID
ENDREG

FIELD
[31:0] 0x00000000
ID[31:0]
RO
Instance identifier number.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0002
REG_SCRATCH
Version and Scratch Registers
ENDREG

FIELD
[31:0] 0x00000000
SCRATCH[31:0]
RW
Scratch register.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0003
REG_CORE_MAGIC
Identification number
ENDREG

FIELD
[31:0] 0x504C5347
CORE_MAGIC[31:0]
RW
Identification number.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0004
REG_RSTN
Reset and load values
ENDREG

FIELD
[1] 0x0
LOAD_CONFIG
WO
Loads the new values written in the config registers.
ENDFIELD

FIELD
[0] 0x0
RESET
RW
Reset, default is (0x0).
ENDFIELD

############################################################################################
############################################################################################

REG
0x0005
REG_NB_PULSES
Number of pulses
ENDREG

FIELD
[31:0] 0x0000
NB_PULSES
RO
Number of configurable pulses.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0010
REG_PULSE_X_PERIOD
Pulse x period
ENDREG

FIELD
[31:0] 0x0000
PULSE_X_PERIOD[31:0] - base + 'h4 for each channel -> e.g. CH3 period - 'h4C
RW
Pulse x duration, defined in number of clock cycles.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0020
REG_PULSE_X_WIDTH
Pulse x width
ENDREG

FIELD
[31:0] 0x0000
PULSE_X_WIDTH[31:0] - base + 'h4 for each channel -> e.g. CH3 width - 'h8C
RW
Pulse x width (high time), defined in number of clock cycles.
ENDFIELD

############################################################################################
############################################################################################

REG
0x0030
REG_PULSE_X_OFFSET
Pulse x offset
ENDREG

FIELD
[31:0] 0x0000
PULSE_X_OFFSET[31:0] - base + 'h4 for each channel -> e.g. CH3 offset - 'hCC
RW
Pulse x offset, defined in number of clock cycles.
ENDFIELD

############################################################################################
############################################################################################
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`TITLE`
			`PWM Generator (axi_pwm_gen)`
docs: add regmap directive Automate table generation for register maps. Based on tfcollins' vger python scripts. There are docs/adi_regmap_*.txt with more than one regmap per file, so the logic changed to allow that. Using title tool as the unique identifier now. It has a global option to set the default state (hidden or visible) for the collpasible tables. Also remove CSVs. Signed-off-by: Jorge Marques <jorge.marques@analog.com> 2023-08-07 19:31:41 +00:00			`axi_pwm_gen`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDTITLE`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0000`
			`REG_VERSION`
			`Version and Scratch Registers`
			`ENDREG`

			`FIELD`
			`[31:0] 0x00010100`
			`VERSION[31:0]`
			`RO`
			`Version number. Unique to all cores.`
			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0001`
			`REG_ID`
			`Core ID`
			`ENDREG`

			`FIELD`
			`[31:0] 0x00000000`
			`ID[31:0]`
			`RO`
			`Instance identifier number.`
			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0002`
			`REG_SCRATCH`
			`Version and Scratch Registers`
			`ENDREG`

			`FIELD`
			`[31:0] 0x00000000`
			`SCRATCH[31:0]`
			`RW`
			`Scratch register.`
			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0003`
			`REG_CORE_MAGIC`
			`Identification number`
			`ENDREG`

			`FIELD`
			`[31:0] 0x504C5347`
			`CORE_MAGIC[31:0]`
			`RW`
			`Identification number.`
			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0004`
			`REG_RSTN`
			`Reset and load values`
			`ENDREG`

			`FIELD`
			`[1] 0x0`
			`LOAD_CONFIG`
			`WO`
			`Loads the new values written in the config registers.`
			`ENDFIELD`

			`FIELD`
			`[0] 0x0`
			`RESET`
			`RW`
			`Reset, default is (0x0).`
			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0005`
			`REG_NB_PULSES`
			`Number of pulses`
			`ENDREG`

			`FIELD`
			`[31:0] 0x0000`
			`NB_PULSES`
			`RO`
			`Number of configurable pulses.`
			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
			`0x0010`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`REG_PULSE_X_PERIOD`
			`Pulse x period`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDREG`

			`FIELD`
			`[31:0] 0x0000`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`PULSE_X_PERIOD[31:0] - base + 'h4 for each channel -> e.g. CH3 period - 'h4C`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`RW`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`Pulse x duration, defined in number of clock cycles.`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`0x0020`
			`REG_PULSE_X_WIDTH`
			`Pulse x width`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDREG`

			`FIELD`
			`[31:0] 0x0000`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`PULSE_X_WIDTH[31:0] - base + 'h4 for each channel -> e.g. CH3 width - 'h8C`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`RW`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`Pulse x width (high time), defined in number of clock cycles.`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`

			`REG`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`0x0030`
			`REG_PULSE_X_OFFSET`
			`Pulse x offset`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDREG`

			`FIELD`
			`[31:0] 0x0000`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`PULSE_X_OFFSET[31:0] - base + 'h4 for each channel -> e.g. CH3 offset - 'hCC`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`RW`
docs/regmap: Update pwm_gen regmap Update the pwm_gen regmap's registers related to period/width/offset Signed-off-by: Alin-Tudor Sferle <Alin-Tudor.Sferle@analog.com> 2024-01-31 07:57:05 +00:00			`Pulse x offset, defined in number of clock cycles.`
docs/regmap: Added ADI regmap_*.txt files (#1008) 2022-09-21 12:12:35 +00:00			`ENDFIELD`

			`############################################################################################`
			`############################################################################################`