stm32-data/data/registers/eth_v1c.yaml

1026 lines
24 KiB
YAML

---
block/ETH:
description: 'Ethernet: media access control (MAC)'
items:
- byte_offset: 0
description: Ethernet MAC configuration register
fieldset: MACCR
name: MACCR
- byte_offset: 4
description: Ethernet MAC frame filter register
fieldset: MACFFR
name: MACFFR
- byte_offset: 8
description: Ethernet MAC hash table high register
fieldset: MACHTHR
name: MACHTHR
- byte_offset: 12
description: Ethernet MAC hash table low register
fieldset: MACHTLR
name: MACHTLR
- byte_offset: 16
description: Ethernet MAC MII address register
fieldset: MACMIIAR
name: MACMIIAR
- byte_offset: 20
description: Ethernet MAC MII data register
fieldset: MACMIIDR
name: MACMIIDR
- byte_offset: 24
description: Ethernet MAC flow control register
fieldset: MACFCR
name: MACFCR
- byte_offset: 28
description: Ethernet MAC VLAN tag register
fieldset: MACVLANTR
name: MACVLANTR
- byte_offset: 44
description: Ethernet MAC PMT control and status register
fieldset: MACPMTCSR
name: MACPMTCSR
- access: Read
byte_offset: 52
description: Ethernet MAC debug register
fieldset: MACDBGR
name: MACDBGR
- byte_offset: 56
description: Ethernet MAC interrupt status register
fieldset: MACSR
name: MACSR
- byte_offset: 60
description: Ethernet MAC interrupt mask register
fieldset: MACIMR
name: MACIMR
- byte_offset: 64
description: Ethernet MAC address 0 high register
fieldset: MACA0HR
name: MACA0HR
- byte_offset: 68
description: Ethernet MAC address 0 low register
fieldset: MACA0LR
name: MACA0LR
- byte_offset: 72
description: Ethernet MAC address 1 high register
fieldset: MACA1HR
name: MACA1HR
- byte_offset: 76
description: Ethernet MAC address1 low register
fieldset: MACA1LR
name: MACA1LR
- byte_offset: 80
description: Ethernet MAC address 2 high register
fieldset: MACA2HR
name: MACA2HR
- byte_offset: 84
description: Ethernet MAC address 2 low register
fieldset: MACA2LR
name: MACA2LR
- byte_offset: 88
description: Ethernet MAC address 3 high register
fieldset: MACA3HR
name: MACA3HR
- byte_offset: 92
description: Ethernet MAC address 3 low register
fieldset: MACA3LR
name: MACA3LR
- byte_offset: 96
description: Ethernet MAC remote wakeup frame filter register
name: MACRWUFFER
enum/APCS:
bit_size: 1
variants:
- description: MAC passes all incoming frames unmodified
name: Disabled
value: 0
- description: MAC strips the Pad/FCS field on incoming frames only for lengths
less than or equal to 1500 bytes
name: Strip
value: 1
enum/BFD:
bit_size: 1
variants:
- description: Address filters pass all received broadcast frames
name: Enabled
value: 0
- description: Address filters filter all incoming broadcast frames
name: Disabled
value: 1
enum/BL:
bit_size: 2
variants:
- description: For retransmission n, wait up to 2^min(n, 10) time slots
name: BL10
value: 0
- description: For retransmission n, wait up to 2^min(n, 8) time slots
name: BL8
value: 1
- description: For retransmission n, wait up to 2^min(n, 4) time slots
name: BL4
value: 2
- description: For retransmission n, wait up to 2^min(n, 1) time slots
name: BL1
value: 3
enum/CR:
bit_size: 3
variants:
- description: 60-100MHz HCLK/42
name: CR_60_100
value: 0
- description: 100-150 MHz HCLK/62
name: CR_100_150
value: 1
- description: 20-35MHz HCLK/16
name: CR_20_35
value: 2
- description: 35-60MHz HCLK/16
name: CR_35_60
value: 3
- description: 150-168MHz HCLK/102
name: CR_150_168
value: 4
enum/CSD:
bit_size: 1
variants:
- description: Errors generated due to loss of carrier
name: Enabled
value: 0
- description: No error generated due to loss of carrier
name: Disabled
value: 1
enum/CSTF:
bit_size: 1
variants:
- description: CRC not stripped
name: Disabled
value: 0
- description: CRC stripped
name: Enabled
value: 1
enum/DAIF:
bit_size: 1
variants:
- description: Normal filtering of frames
name: Normal
value: 0
- description: Address check block operates in inverse filtering mode for the DA
address comparison
name: Invert
value: 1
enum/DC:
bit_size: 1
variants:
- description: MAC defers until CRS signal goes inactive
name: Disabled
value: 0
- description: Deferral check function enabled
name: Enabled
value: 1
enum/DM:
bit_size: 1
variants:
- description: MAC operates in half-duplex mode
name: HalfDuplex
value: 0
- description: MAC operates in full-duplex mode
name: FullDuplex
value: 1
enum/FCB:
bit_size: 1
variants:
- description: In half duplex only, deasserts back pressure
name: DisableBackPressure
value: 0
- description: In full duplex, initiate a Pause control frame. In half duplex, assert
back pressure
name: PauseOrBackPressure
value: 1
enum/FES:
bit_size: 1
variants:
- description: 10 Mbit/s
name: FES10
value: 0
- description: 100 Mbit/s
name: FES100
value: 1
enum/GU:
bit_size: 1
variants:
- description: Normal operation
name: Disabled
value: 0
- description: Any unicast packet filtered by the MAC address recognition may be
a wakeup frame
name: Enabled
value: 1
enum/HM:
bit_size: 1
variants:
- description: MAC performs a perfect destination address filtering for multicast
frames
name: Perfect
value: 0
- description: MAC performs destination address filtering of received multicast
frames according to the hash table
name: Hash
value: 1
enum/HPF:
bit_size: 1
variants:
- description: If HM or HU is set, only frames that match the Hash filter are passed
name: HashOnly
value: 0
- description: If HM or HU is set, frames that match either the perfect filter or
the hash filter are passed
name: HashOrPerfect
value: 1
enum/HU:
bit_size: 1
variants:
- description: MAC performs a perfect destination address filtering for unicast
frames
name: Perfect
value: 0
- description: MAC performs destination address filtering of received unicast frames
according to the hash table
name: Hash
value: 1
enum/IFG:
bit_size: 3
variants:
- description: 96 bit times
name: IFG96
value: 0
- description: 88 bit times
name: IFG88
value: 1
- description: 80 bit times
name: IFG80
value: 2
- description: 72 bit times
name: IFG72
value: 3
- description: 64 bit times
name: IFG64
value: 4
- description: 56 bit times
name: IFG56
value: 5
- description: 48 bit times
name: IFG48
value: 6
- description: 40 bit times
name: IFG40
value: 7
enum/IPCO:
bit_size: 1
variants:
- description: IPv4 checksum offload disabled
name: Disabled
value: 0
- description: IPv4 checksums are checked in received frames
name: Offload
value: 1
enum/JD:
bit_size: 1
variants:
- description: Jabber enabled, transmit frames up to 2048 bytes
name: Enabled
value: 0
- description: Jabber disabled, transmit frames up to 16384 bytes
name: Disabled
value: 1
enum/LM:
bit_size: 1
variants:
- description: Normal mode
name: Normal
value: 0
- description: MAC operates in loopback mode at the MII
name: Loopback
value: 1
enum/MACAHR_AE:
bit_size: 1
variants:
- description: Address filters ignore this address
name: Disabled
value: 0
- description: Address filters use this address
name: Enabled
value: 1
enum/MACAHR_SA:
bit_size: 1
variants:
- description: This address is used for comparison with DA fields of the received
frame
name: Destination
value: 0
- description: This address is used for comparison with SA fields of received frames
name: Source
value: 1
enum/MB:
bit_size: 1
variants:
- description: This bit is set to 1 by the application to indicate that a read or
write access is in progress
name: Busy
value: 1
enum/MPE:
bit_size: 1
variants:
- description: No power management event generated due to Magic Packet reception
name: Disabled
value: 0
- description: Enable generation of a power management event due to Magic Packet
reception
name: Enabled
value: 1
enum/MW:
bit_size: 1
variants:
- description: Read operation
name: Read
value: 0
- description: Write operation
name: Write
value: 1
enum/PAM:
bit_size: 1
variants:
- description: Filtering of multicast frames depends on HM
name: Disabled
value: 0
- description: All received frames with a multicast destination address are passed
name: Enabled
value: 1
enum/PCF:
bit_size: 2
variants:
- description: MAC prevents all control frames from reaching the application
name: PreventAll
value: 0
- description: MAC forwards all control frames to application except Pause
name: ForwardAllExceptPause
value: 1
- description: MAC forwards all control frames to application even if they fail
the address filter
name: ForwardAll
value: 2
- description: MAC forwards control frames that pass the address filter
name: ForwardAllFiltered
value: 3
enum/PD:
bit_size: 1
variants:
- description: All received frames will be dropped. Cleared automatically when a
magic packet or wakeup frame is received
name: Enabled
value: 1
enum/PLT:
bit_size: 2
variants:
- description: Pause time minus 4 slot times
name: PLT4
value: 0
- description: Pause time minus 28 slot times
name: PLT28
value: 1
- description: Pause time minus 144 slot times
name: PLT144
value: 2
- description: Pause time minus 256 slot times
name: PLT256
value: 3
enum/PM:
bit_size: 1
variants:
- description: Normal address filtering
name: Disabled
value: 0
- description: Address filters pass all incoming frames regardless of their destination
or source address
name: Enabled
value: 1
enum/PMTIM:
bit_size: 1
variants:
- description: PMT Status interrupt generation enabled
name: Unmasked
value: 0
- description: PMT Status interrupt generation disabled
name: Masked
value: 1
enum/RA:
bit_size: 1
variants:
- description: MAC receiver passes on to the application only those frames that
have passed the SA/DA address file
name: Disabled
value: 0
- description: MAC receiver passes oll received frames on to the application
name: Enabled
value: 1
enum/RD:
bit_size: 1
variants:
- description: MAC attempts retries based on the settings of BL
name: Enabled
value: 0
- description: MAC attempts only 1 transmission
name: Disabled
value: 1
enum/RE:
bit_size: 1
variants:
- description: MAC receive state machine is disabled after the completion of the
reception of the current frame
name: Disabled
value: 0
- description: MAC receive state machine is enabled
name: Enabled
value: 1
enum/RFCE:
bit_size: 1
variants:
- description: Pause frames are not decoded
name: Disabled
value: 0
- description: MAC decodes received Pause frames and disables its transmitted for
a specified time
name: Enabled
value: 1
enum/ROD:
bit_size: 1
variants:
- description: MAC receives all packets from PHY while transmitting
name: Enabled
value: 0
- description: MAC disables reception of frames in half-duplex mode
name: Disabled
value: 1
enum/SAF:
bit_size: 1
variants:
- description: Source address ignored
name: Disabled
value: 0
- description: MAC drops frames that fail the source address filter
name: Enabled
value: 1
enum/SAIF:
bit_size: 1
variants:
- description: Source address filter operates normally
name: Normal
value: 0
- description: Source address filter operation inverted
name: Invert
value: 1
enum/TE:
bit_size: 1
variants:
- description: MAC transmit state machine is disabled after completion of the transmission
of the current frame
name: Disabled
value: 0
- description: MAC transmit state machine is enabled
name: Enabled
value: 1
enum/TFCE:
bit_size: 1
variants:
- description: In full duplex, flow control is disabled. In half duplex, back pressure
is disabled
name: Disabled
value: 0
- description: In full duplex, flow control is enabled. In half duplex, back pressure
is enabled
name: Enabled
value: 1
enum/TSTIM:
bit_size: 1
variants:
- description: Time stamp interrupt generation enabled
name: Unmasked
value: 0
- description: Time stamp interrupt generation disabled
name: Masked
value: 1
enum/UPFD:
bit_size: 1
variants:
- description: MAC detects only a Pause frame with the multicast address specified
in the 802.3x standard
name: Disabled
value: 0
- description: MAC additionally detects Pause frames with the station's unicast
address
name: Enabled
value: 1
enum/VLANTC:
bit_size: 1
variants:
- description: Full 16 bit VLAN identifiers are used for comparison and filtering
name: VLANTC16
value: 0
- description: 12 bit VLAN identifies are used for comparison and filtering
name: VLANTC12
value: 1
enum/WD:
bit_size: 1
variants:
- description: Watchdog enabled, receive frames limited to 2048 bytes
name: Enabled
value: 0
- description: Watchdog disabled, receive frames may be up to to 16384 bytes
name: Disabled
value: 1
enum/WFE:
bit_size: 1
variants:
- description: No power management event generated due to wakeup frame reception
name: Disabled
value: 0
- description: Enable generation of a power management event due to wakeup frame
reception
name: Enabled
value: 1
enum/WFFRPR:
bit_size: 1
variants:
- description: Reset wakeup frame filter register point to 0b000. Automatically
cleared
name: Reset
value: 1
enum/ZQPD:
bit_size: 1
variants:
- description: Normal operation with automatic zero-quanta pause control frame generation
name: Enabled
value: 0
- description: Automatic generation of zero-quanta pause control frames is disabled
name: Disabled
value: 1
fieldset/MACA0HR:
description: Ethernet MAC address 0 high register
fields:
- bit_offset: 0
bit_size: 16
description: MAC address0 high
name: MACA0H
- bit_offset: 31
bit_size: 1
description: Always 1
name: MO
fieldset/MACA0LR:
description: Ethernet MAC address 0 low register
fields:
- bit_offset: 0
bit_size: 32
description: '0'
name: MACA0L
fieldset/MACA1HR:
description: Ethernet MAC address 1 high register
fields:
- bit_offset: 0
bit_size: 16
description: MACA1H
name: MACA1H
- bit_offset: 24
bit_size: 6
description: MBC
name: MBC
- bit_offset: 30
bit_size: 1
description: SA
enum: MACAHR_SA
name: SA
- bit_offset: 31
bit_size: 1
description: AE
enum: MACAHR_AE
name: AE
fieldset/MACA1LR:
description: Ethernet MAC address1 low register
fields:
- bit_offset: 0
bit_size: 32
description: MACA1LR
name: MACA1L
fieldset/MACA2HR:
description: Ethernet MAC address 2 high register
fields:
- bit_offset: 0
bit_size: 16
description: MAC2AH
name: MACA2H
- bit_offset: 24
bit_size: 6
description: MBC
name: MBC
- bit_offset: 30
bit_size: 1
description: SA
enum: MACAHR_SA
name: SA
- bit_offset: 31
bit_size: 1
description: AE
enum: MACAHR_AE
name: AE
fieldset/MACA2LR:
description: Ethernet MAC address 2 low register
fields:
- bit_offset: 0
bit_size: 32
description: MACA2L
name: MACA2L
fieldset/MACA3HR:
description: Ethernet MAC address 3 high register
fields:
- bit_offset: 0
bit_size: 16
description: MACA3H
name: MACA3H
- bit_offset: 24
bit_size: 6
description: MBC
name: MBC
- bit_offset: 30
bit_size: 1
description: SA
enum: MACAHR_SA
name: SA
- bit_offset: 31
bit_size: 1
description: AE
enum: MACAHR_AE
name: AE
fieldset/MACA3LR:
description: Ethernet MAC address 3 low register
fields:
- bit_offset: 0
bit_size: 32
description: MBCA3L
name: MACA3L
fieldset/MACCR:
description: Ethernet MAC configuration register
fields:
- bit_offset: 2
bit_size: 1
description: Receiver enable
enum: RE
name: RE
- bit_offset: 3
bit_size: 1
description: Transmitter enable
enum: TE
name: TE
- bit_offset: 4
bit_size: 1
description: Deferral check
enum: DC
name: DC
- bit_offset: 5
bit_size: 2
description: Back-off limit
enum: BL
name: BL
- bit_offset: 7
bit_size: 1
description: Automatic pad/CRC stripping
enum: APCS
name: APCS
- bit_offset: 9
bit_size: 1
description: Retry disable
enum: RD
name: RD
- bit_offset: 10
bit_size: 1
description: IPv4 checksum offload
enum: IPCO
name: IPCO
- bit_offset: 11
bit_size: 1
description: Duplex mode
enum: DM
name: DM
- bit_offset: 12
bit_size: 1
description: Loopback mode
enum: LM
name: LM
- bit_offset: 13
bit_size: 1
description: Receive own disable
enum: ROD
name: ROD
- bit_offset: 14
bit_size: 1
description: Fast Ethernet speed
enum: FES
name: FES
- bit_offset: 16
bit_size: 1
description: Carrier sense disable
enum: CSD
name: CSD
- bit_offset: 17
bit_size: 3
description: Interframe gap
enum: IFG
name: IFG
- bit_offset: 22
bit_size: 1
description: Jabber disable
enum: JD
name: JD
- bit_offset: 23
bit_size: 1
description: Watchdog disable
enum: WD
name: WD
- bit_offset: 25
bit_size: 1
description: CRC stripping for type frames
enum: CSTF
name: CSTF
fieldset/MACDBGR:
description: Ethernet MAC debug register
fields:
- bit_offset: 0
bit_size: 1
description: MAC MII receive protocol engine active
name: MMRPEA
- bit_offset: 1
bit_size: 2
description: MAC small FIFO read/write controllers status
name: MSFRWCS
- bit_offset: 4
bit_size: 1
description: Rx FIFO write controller active
name: RFWRA
- bit_offset: 5
bit_size: 2
description: Rx FIFO read controller status
name: RFRCS
- bit_offset: 8
bit_size: 2
description: Rx FIFO fill level
name: RFFL
- bit_offset: 16
bit_size: 1
description: MAC MII transmit engine active
name: MMTEA
- bit_offset: 17
bit_size: 2
description: MAC transmit frame controller status
name: MTFCS
- bit_offset: 19
bit_size: 1
description: MAC transmitter in pause
name: MTP
- bit_offset: 20
bit_size: 2
description: Tx FIFO read status
name: TFRS
- bit_offset: 22
bit_size: 1
description: Tx FIFO write active
name: TFWA
- bit_offset: 24
bit_size: 1
description: Tx FIFO not empty
name: TFNE
- bit_offset: 25
bit_size: 1
description: Tx FIFO full
name: TFF
fieldset/MACFCR:
description: Ethernet MAC flow control register
fields:
- bit_offset: 0
bit_size: 1
description: Flow control busy/back pressure activate
enum: FCB
name: FCB
- bit_offset: 1
bit_size: 1
description: Transmit flow control enable
enum: TFCE
name: TFCE
- bit_offset: 2
bit_size: 1
description: Receive flow control enable
enum: RFCE
name: RFCE
- bit_offset: 3
bit_size: 1
description: Unicast pause frame detect
enum: UPFD
name: UPFD
- bit_offset: 4
bit_size: 2
description: Pause low threshold
enum: PLT
name: PLT
- bit_offset: 7
bit_size: 1
description: Zero-quanta pause disable
enum: ZQPD
name: ZQPD
- bit_offset: 16
bit_size: 16
description: Pause time
name: PT
fieldset/MACFFR:
description: Ethernet MAC frame filter register
fields:
- bit_offset: 0
bit_size: 1
description: Promiscuous mode
enum: PM
name: PM
- bit_offset: 1
bit_size: 1
description: Hash unicast
enum: HU
name: HU
- bit_offset: 2
bit_size: 1
description: Hash multicast
enum: HM
name: HM
- bit_offset: 3
bit_size: 1
description: Destination address unique filtering
enum: DAIF
name: DAIF
- bit_offset: 4
bit_size: 1
description: Pass all multicast
enum: PAM
name: PAM
- bit_offset: 5
bit_size: 1
description: Broadcast frames disable
enum: BFD
name: BFD
- bit_offset: 6
bit_size: 2
description: Pass control frames
enum: PCF
name: PCF
- bit_offset: 7
bit_size: 1
description: Source address inverse filtering
enum: SAIF
name: SAIF
- bit_offset: 8
bit_size: 1
description: Source address filter
enum: SAF
name: SAF
- bit_offset: 9
bit_size: 1
description: Hash or perfect filter
enum: HPF
name: HPF
- bit_offset: 31
bit_size: 1
description: Receive all
enum: RA
name: RA
fieldset/MACHTHR:
description: Ethernet MAC hash table high register
fields:
- bit_offset: 0
bit_size: 32
description: Upper 32 bits of hash table
name: HTH
fieldset/MACHTLR:
description: Ethernet MAC hash table low register
fields:
- bit_offset: 0
bit_size: 32
description: Lower 32 bits of hash table
name: HTL
fieldset/MACIMR:
description: Ethernet MAC interrupt mask register
fields:
- bit_offset: 3
bit_size: 1
description: PMT interrupt mask
enum: PMTIM
name: PMTIM
- bit_offset: 9
bit_size: 1
description: Time stamp trigger interrupt mask
enum: TSTIM
name: TSTIM
fieldset/MACMIIAR:
description: Ethernet MAC MII address register
fields:
- bit_offset: 0
bit_size: 1
description: MII busy
enum: MB
name: MB
- bit_offset: 1
bit_size: 1
description: MII write
enum: MW
name: MW
- bit_offset: 2
bit_size: 3
description: Clock range
enum: CR
name: CR
- bit_offset: 6
bit_size: 5
description: MII register - select the desired MII register in the PHY device
name: MR
- bit_offset: 11
bit_size: 5
description: PHY address - select which of possible 32 PHYs is being accessed
name: PA
fieldset/MACMIIDR:
description: Ethernet MAC MII data register
fields:
- bit_offset: 0
bit_size: 16
description: MII data read from/written to the PHY
name: MD
fieldset/MACPMTCSR:
description: Ethernet MAC PMT control and status register
fields:
- bit_offset: 0
bit_size: 1
description: Power down
enum: PD
name: PD
- bit_offset: 1
bit_size: 1
description: Magic packet enable
enum: MPE
name: MPE
- bit_offset: 2
bit_size: 1
description: Wakeup frame enable
enum: WFE
name: WFE
- bit_offset: 5
bit_size: 1
description: Magic packet received
name: MPR
- bit_offset: 6
bit_size: 1
description: Wakeup frame received
name: WFR
- bit_offset: 9
bit_size: 1
description: Global unicast
enum: GU
name: GU
- bit_offset: 31
bit_size: 1
description: Wakeup frame filter register pointer reset
enum: WFFRPR
name: WFFRPR
fieldset/MACSR:
description: Ethernet MAC interrupt status register
fields:
- bit_offset: 3
bit_size: 1
description: PMT status
name: PMTS
- bit_offset: 4
bit_size: 1
description: MMC status
name: MMCS
- bit_offset: 5
bit_size: 1
description: MMC receive status
name: MMCRS
- bit_offset: 6
bit_size: 1
description: MMC transmit status
name: MMCTS
- bit_offset: 9
bit_size: 1
description: Time stamp trigger status
name: TSTS
fieldset/MACVLANTR:
description: Ethernet MAC VLAN tag register
fields:
- bit_offset: 0
bit_size: 16
description: VLAN tag identifier (for receive frames)
name: VLANTI
- bit_offset: 16
bit_size: 1
description: 12-bit VLAN tag comparison
enum: VLANTC
name: VLANTC