give enums real names

This commit is contained in:
ExplodingWaffle 2023-09-01 16:40:50 +01:00
parent 30dcf3cabe
commit eeadbd3f7b

View File

@ -59,7 +59,7 @@ block/UCPD:
description: "Rx ordered set extension register 2 \t" description: "Rx ordered set extension register 2 \t"
byte_offset: 56 byte_offset: 56
fieldset: RX_ORDEXTR2 fieldset: RX_ORDEXTR2
# TODO: IPVER, IPID and MID from g0[7, 8]1? do we care? # TODO: IPVER, IPID and MID from g0[7, 8]1 svds? do we care?
fieldset/CFGR1: fieldset/CFGR1:
description: "configuration register 1 " description: "configuration register 1 "
fields: fields:
@ -106,7 +106,6 @@ fieldset/CFGR2:
description: "BMC decoder Rx pre-filter sampling method\r Number of consistent consecutive samples before confirming a new value." description: "BMC decoder Rx pre-filter sampling method\r Number of consistent consecutive samples before confirming a new value."
bit_offset: 1 bit_offset: 1
bit_size: 1 bit_size: 1
enum: RXFILT2N3
- name: FORCECLK - name: FORCECLK
description: Force ClkReq clock request description: Force ClkReq clock request
bit_offset: 2 bit_offset: 2
@ -116,6 +115,7 @@ fieldset/CFGR2:
bit_offset: 3 bit_offset: 3
bit_size: 1 bit_size: 1
fieldset/CFGR3: fieldset/CFGR3:
# TODO: sort out this mess
description: "configuration register 3 " description: "configuration register 3 "
fields: fields:
- name: TRIM1_NG_CCRPD - name: TRIM1_NG_CCRPD
@ -186,6 +186,11 @@ fieldset/CR:
description: VCONN switch enable for CC2 description: VCONN switch enable for CC2
bit_offset: 14 bit_offset: 14
bit_size: 1 bit_size: 1
# TODO: this is fine, right?
- name: DBATTEN
description: "Dead battery function enable\r The bit takes effect upon setting the USBPDstrobe bit of the SYS_CONFIG register.\r Dead battery function only operates if the external circuit is appropriately configured."
bit_offset: 15
bit_size: 1
- name: FRSRXEN - name: FRSRXEN
description: "FRS event detection enable\r Setting the bit enables FRS Rx event (FRSEVT) detection on the CC line selected through the PHYCCSEL bit. 0: Disable\r Clear the bit when the device is attached to an FRS-incapable source/sink." description: "FRS event detection enable\r Setting the bit enables FRS Rx event (FRSEVT) detection on the CC line selected through the PHYCCSEL bit. 0: Disable\r Clear the bit when the device is attached to an FRS-incapable source/sink."
bit_offset: 16 bit_offset: 16
@ -433,12 +438,12 @@ fieldset/SR:
description: "The status bitfield indicates the voltage level on the CC1 line in its steady state.\r The voltage variation on the CC1 line during USB PD messages due to the BMC PHY modulation does not impact the bitfield value." description: "The status bitfield indicates the voltage level on the CC1 line in its steady state.\r The voltage variation on the CC1 line during USB PD messages due to the BMC PHY modulation does not impact the bitfield value."
bit_offset: 16 bit_offset: 16
bit_size: 2 bit_size: 2
enum: TYPEC_VSTATE_CC1 enum: TYPEC_VSTATE_CC
- name: TYPEC_VSTATE_CC2 - name: TYPEC_VSTATE_CC2
description: "CC2 line voltage level\r The status bitfield indicates the voltage level on the CC2 line in its steady state.\r The voltage variation on the CC2 line during USB PD messages due to the BMC PHY modulation does not impact the bitfield value." description: "CC2 line voltage level\r The status bitfield indicates the voltage level on the CC2 line in its steady state.\r The voltage variation on the CC2 line during USB PD messages due to the BMC PHY modulation does not impact the bitfield value."
bit_offset: 18 bit_offset: 18
bit_size: 2 bit_size: 2
enum: TYPEC_VSTATE_CC2 enum: TYPEC_VSTATE_CC
- name: FRSEVT - name: FRSEVT
description: "FRS detection event\r The flag is cleared by setting the FRSEVTCF bit." description: "FRS detection event\r The flag is cleared by setting the FRSEVTCF bit."
bit_offset: 20 bit_offset: 20
@ -467,129 +472,106 @@ fieldset/TX_PAYSZR:
enum/ANAMODE: enum/ANAMODE:
bit_size: 1 bit_size: 1
variants: variants:
- name: B_0x0 - name: Source
description: Source description: Source
value: 0 value: 0
- name: B_0x1 - name: Sink
description: Sink description: Sink
value: 1 value: 1
enum/CCENABLE: enum/CCENABLE:
bit_size: 2 bit_size: 2
# TODO: should this maybe be 2 fields, CCxENABLE?
variants: variants:
- name: B_0x0 - name: Disabled
description: "Disable both PHYs " description: "Disable both PHYs "
value: 0 value: 0
- name: B_0x1 - name: Cc1
description: Enable CC1 PHY description: Enable CC1 PHY
value: 1 value: 1
- name: B_0x2 - name: Cc2
description: Enable CC2 PHY description: Enable CC2 PHY
value: 2 value: 2
- name: B_0x3 - name: Both
description: Enable CC1 and CC2 PHY description: Enable CC1 and CC2 PHY
value: 3 value: 3
enum/PHYCCSEL: enum/PHYCCSEL:
bit_size: 1 bit_size: 1
variants: variants:
- name: B_0x0 - name: Cc1
description: Use CC1 IO for Power Delivery communication description: Use CC1 IO for Power Delivery communication
value: 0 value: 0
- name: B_0x1 - name: Cc2
description: Use CC2 IO for Power Delivery communication description: Use CC2 IO for Power Delivery communication
value: 1 value: 1
enum/RXFILT2N3:
bit_size: 1
variants:
- name: B_0x0
description: 3 samples
value: 0
- name: B_0x1
description: 2 samples
value: 1
enum/RXORDSET: enum/RXORDSET:
bit_size: 3 bit_size: 3
variants: variants:
- name: B_0x0 - name: Sop
description: SOP code detected in receiver description: SOP code detected in receiver
value: 0 value: 0
- name: B_0x1 - name: SopPrime
description: "SOP' code detected in receiver" description: "SOP' code detected in receiver"
value: 1 value: 1
- name: B_0x2 - name: SopDoublePrime
description: "SOP'' code detected in receiver" description: "SOP'' code detected in receiver"
value: 2 value: 2
- name: B_0x3 - name: SopPrimeDebug
description: "SOP'_Debug detected in receiver" description: "SOP'_Debug detected in receiver"
value: 3 value: 3
- name: B_0x4 - name: SopDoublePrimeDebug
description: "SOP''_Debug detected in receiver" description: "SOP''_Debug detected in receiver"
value: 4 value: 4
- name: B_0x5 - name: CableReset
description: Cable Reset detected in receiver description: Cable Reset detected in receiver
value: 5 value: 5
- name: B_0x6 - name: Ext1
description: "SOP extension#1 detected in receiver" description: "SOP extension#1 detected in receiver"
value: 6 value: 6
- name: B_0x7 - name: Ext2
description: "SOP extension#2 detected in receiver" description: "SOP extension#2 detected in receiver"
value: 7 value: 7
enum/RXSOPKINVALID: enum/RXSOPKINVALID:
bit_size: 3 bit_size: 3
variants: variants:
- name: B_0x0 - name: None
description: No Kcode corrupted description: No Kcode corrupted
value: 0 value: 0
- name: B_0x1 - name: First
description: First Kcode corrupted description: First Kcode corrupted
value: 1 value: 1
- name: B_0x2 - name: Second
description: Second Kcode corrupted description: Second Kcode corrupted
value: 2 value: 2
- name: B_0x3 - name: Third
description: Third Kcode corrupted description: Third Kcode corrupted
value: 3 value: 3
- name: B_0x4 - name: Fourth
description: Fourth Kcode corrupted description: Fourth Kcode corrupted
value: 4 value: 4
enum/TXMODE: enum/TXMODE:
bit_size: 2 bit_size: 2
variants: variants:
- name: B_0x0 - name: Packet
description: Transmission of Tx packet previously defined in other registers description: Transmission of Tx packet previously defined in other registers
value: 0 value: 0
- name: B_0x1 - name: CableReset
description: Cable Reset sequence description: Cable Reset sequence
value: 1 value: 1
- name: B_0x2 - name: Bist
description: BIST test sequence (BIST Carrier Mode 2) description: BIST test sequence (BIST Carrier Mode 2)
value: 2 value: 2
enum/TYPEC_VSTATE_CC1: enum/TYPEC_VSTATE_CC:
bit_size: 2 bit_size: 2
variants: variants:
- name: B_0x0 - name: Lowest
description: Lowest description: Lowest
value: 0 value: 0
- name: B_0x1 - name: Low
description: Low description: Low
value: 1 value: 1
- name: B_0x2 - name: High
description: High description: High
value: 2 value: 2
- name: B_0x3 - name: Highest
description: Highest
value: 3
enum/TYPEC_VSTATE_CC2:
bit_size: 2
variants:
- name: B_0x0
description: Lowest
value: 0
- name: B_0x1
description: Low
value: 1
- name: B_0x2
description: High
value: 2
- name: B_0x3
description: Highest description: Highest
value: 3 value: 3