[v3,08/11] hw/net: General GMAC Implementation

From: Nabih Estefan Diaz <nabihestefan@google.com>

- General GMAC Register handling
- GMAC IRQ Handling
- Added traces in some methods for debugging
- Lots of declarations for accessing information on GMAC Descriptors (npcm_gmac.h file)

NOTE: With code on this state, the GMAC can boot-up properly and will show up in the ifconfig command on the BMC

Google-Rebase-Count: 1
Signed-off-by: Nabih Estefan Diaz <nabihestefan@google.com>
Google-Bug-Id: 237557100
Change-Id: I3a4332ee5bab31b919782031a77c5b943f45ca2f
---
 include/hw/net/npcm_gmac.h | 198 ++++++++++++++++++++++++++++++++++---
 1 file changed, 184 insertions(+), 14 deletions(-)

On Tue, Oct 17, 2023 at 4:04 PM Nabih Estefan <nabihestefan@google.com>
wrote:

> From: Nabih Estefan Diaz <nabihestefan@google.com>
>
> - General GMAC Register handling
> - GMAC IRQ Handling
> - Added traces in some methods for debugging
> - Lots of declarations for accessing information on GMAC Descriptors
> (npcm_gmac.h file)
>
> NOTE: With code on this state, the GMAC can boot-up properly and will show
> up in the ifconfig command on the BMC
>
> Google-Rebase-Count: 1
> Signed-off-by: Nabih Estefan Diaz <nabihestefan@google.com>
> Google-Bug-Id: 237557100
> Change-Id: I3a4332ee5bab31b919782031a77c5b943f45ca2f
>
Please remove the Google-specific hashes. (Only signed-off-by is needed.)

> ---
>  include/hw/net/npcm_gmac.h | 198 ++++++++++++++++++++++++++++++++++---
>  1 file changed, 184 insertions(+), 14 deletions(-)
>
> diff --git a/include/hw/net/npcm_gmac.h b/include/hw/net/npcm_gmac.h
> index e5729e83ea..c97eb6fe6e 100644
> --- a/include/hw/net/npcm_gmac.h
> +++ b/include/hw/net/npcm_gmac.h
> @@ -34,13 +34,15 @@ struct NPCMGMACRxDesc {
>  };
>
>  /* NPCMGMACRxDesc.flags values */
> -/* RDES2 and RDES3 are buffer address pointers */
> -/* Owner: 0 = software, 1 = gmac */
> -#define RX_DESC_RDES0_OWNER_MASK BIT(31)
> +/* RDES2 and RDES3 are buffer addresses */
> +/* Owner: 0 = software, 1 = dma */
> +#define RX_DESC_RDES0_OWN BIT(31)
>  /* Destination Address Filter Fail */
> -#define RX_DESC_RDES0_DEST_ADDR_FILT_FAIL_MASK BIT(30)
> -/* Frame length*/
> -#define RX_DESC_RDES0_FRAME_LEN_MASK(word) extract32(word, 16, 29)
> +#define RX_DESC_RDES0_DEST_ADDR_FILT_FAIL BIT(30)
> +/* Frame length */
> +#define RX_DESC_RDES0_FRAME_LEN_MASK(word) extract32(word, 16, 14)
> +/* Frame length Shift*/
> +#define RX_DESC_RDES0_FRAME_LEN_SHIFT 16
>  /* Error Summary */
>  #define RX_DESC_RDES0_ERR_SUMM_MASK BIT(15)
>  /* Descriptor Error */
> @@ -83,9 +85,9 @@ struct NPCMGMACRxDesc {
>  /* Receive Buffer 2 Size */
>  #define RX_DESC_RDES1_BFFR2_SZ_SHIFT 11
>  #define RX_DESC_RDES1_BFFR2_SZ_MASK(word) extract32(word, \
> -    RX_DESC_RDES1_BFFR2_SZ_SHIFT, 10 + RX_DESC_RDES1_BFFR2_SZ_SHIFT)
> +    RX_DESC_RDES1_BFFR2_SZ_SHIFT, 11)
>  /* Receive Buffer 1 Size */
> -#define RX_DESC_RDES1_BFFR1_SZ_MASK(word) extract32(word, 0, 10)
> +#define RX_DESC_RDES1_BFFR1_SZ_MASK(word) extract32(word, 0, 11)
>
>
>  struct NPCMGMACTxDesc {
> @@ -96,9 +98,9 @@ struct NPCMGMACTxDesc {
>  };
>
>  /* NPCMGMACTxDesc.flags values */
> -/* TDES2 and TDES3 are buffer address pointers */
> +/* TDES2 and TDES3 are buffer addresses */
>  /* Owner: 0 = software, 1 = gmac */
> -#define TX_DESC_TDES0_OWNER_MASK BIT(31)
> +#define TX_DESC_TDES0_OWN BIT(31)
>  /* Tx Time Stamp Status */
>  #define TX_DESC_TDES0_TTSS_MASK BIT(17)
>  /* IP Header Error */
> @@ -122,7 +124,7 @@ struct NPCMGMACTxDesc {
>  /* VLAN Frame */
>  #define TX_DESC_TDES0_VLAN_FRM_MASK BIT(7)
>  /* Collision Count */
> -#define TX_DESC_TDES0_COLL_CNT_MASK(word) extract32(word, 3, 6)
> +#define TX_DESC_TDES0_COLL_CNT_MASK(word) extract32(word, 3, 4)
>  /* Excessive Deferral */
>  #define TX_DESC_TDES0_EXCS_DEF_MASK BIT(2)
>  /* Underflow Error */
> @@ -137,7 +139,7 @@ struct NPCMGMACTxDesc {
>  /* Last Segment */
>  #define TX_DESC_TDES1_FIRST_SEG_MASK BIT(29)
>  /* Checksum Insertion Control */
> -#define TX_DESC_TDES1_CHKSM_INS_CTRL_MASK(word) extract32(word, 27, 28)
> +#define TX_DESC_TDES1_CHKSM_INS_CTRL_MASK(word) extract32(word, 27, 2)
>  /* Disable Cyclic Redundancy Check */
>  #define TX_DESC_TDES1_DIS_CDC_MASK BIT(26)
>  /* Transmit End of Ring */
> @@ -145,9 +147,9 @@ struct NPCMGMACTxDesc {
>  /* Secondary Address Chained */
>  #define TX_DESC_TDES1_SEC_ADDR_CHND_MASK BIT(24)
>  /* Transmit Buffer 2 Size */
> -#define TX_DESC_TDES1_BFFR2_SZ_MASK(word) extract32(word, 11, 21)
> +#define TX_DESC_TDES1_BFFR2_SZ_MASK(word) extract32(word, 11, 11)
>  /* Transmit Buffer 1 Size */
> -#define TX_DESC_TDES1_BFFR1_SZ_MASK(word) extract32(word, 0, 10)
> +#define TX_DESC_TDES1_BFFR1_SZ_MASK(word) extract32(word, 0, 11)
>
>  typedef struct NPCMGMACState {
>      SysBusDevice parent;
> @@ -165,4 +167,172 @@ typedef struct NPCMGMACState {
>  #define TYPE_NPCM_GMAC "npcm-gmac"
>  OBJECT_DECLARE_SIMPLE_TYPE(NPCMGMACState, NPCM_GMAC)
>
> +/* Mask for RO bits in Status */
> +#define NPCM_DMA_STATUS_RO_MASK(word) (word & 0xfffe0000)
> +/* Mask for RO bits in Status */
> +#define NPCM_DMA_STATUS_W1C_MASK(word) (word & 0x1e7ff)
> +
> +/* Transmit Process State */
> +#define NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT 20
> +/* Transmit States */
> +#define NPCM_DMA_STATUS_TX_STOPPED_STATE \
> +    (0b000 << NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_TX_RUNNING_FETCHING_STATE \
> +    (0b001 << NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_TX_RUNNING_WAITING_STATE \
> +    (0b010 << NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_TX_RUNNING_READ_STATE \
> +    (0b011 << NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_TX_SUSPENDED_STATE \
> +    (0b110 << NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_TX_RUNNING_CLOSING_STATE \
> +    (0b111 << NPCM_DMA_STATUS_TX_PROCESS_STATE_SHIFT)
> +/* Transmit Process State */
> +#define NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT 17
> +/* Receive States */
> +#define NPCM_DMA_STATUS_RX_STOPPED_STATE \
> +    (0b000 << NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_RX_RUNNING_FETCHING_STATE \
> +    (0b001 << NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_RX_RUNNING_WAITING_STATE \
> +    (0b011 << NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_RX_SUSPENDED_STATE \
> +    (0b100 << NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_RX_RUNNING_CLOSING_STATE \
> +    (0b101 << NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT)
> +#define NPCM_DMA_STATUS_RX_RUNNING_TRANSFERRING_STATE \
> +    (0b111 << NPCM_DMA_STATUS_RX_PROCESS_STATE_SHIFT)
> +
> +
> +/* Early Receive Interrupt */
> +#define NPCM_DMA_STATUS_ERI BIT(14)
> +/* Fatal Bus Error Interrupt */
> +#define NPCM_DMA_STATUS_FBI BIT(13)
> +/* Early transmit Interrupt */
> +#define NPCM_DMA_STATUS_ETI BIT(10)
> +/* Receive Watchdog Timout */
> +#define NPCM_DMA_STATUS_RWT BIT(9)
> +/* Receive Process Stopped */
> +#define NPCM_DMA_STATUS_RPS BIT(8)
> +/* Receive Buffer Unavailable */
> +#define NPCM_DMA_STATUS_RU BIT(7)
> +/* Receive Interrupt */
> +#define NPCM_DMA_STATUS_RI BIT(6)
> +/* Transmit Underflow */
> +#define NPCM_DMA_STATUS_UNF BIT(5)
> +/* Receive Overflow */
> +#define NPCM_DMA_STATUS_OVF BIT(4)
> +/* Transmit Jabber Timeout */
> +#define NPCM_DMA_STATUS_TJT BIT(3)
> +/* Transmit Buffer Unavailable */
> +#define NPCM_DMA_STATUS_TU BIT(2)
> +/* Transmit Process Stopped */
> +#define NPCM_DMA_STATUS_TPS BIT(1)
> +/* Transmit Interrupt */
> +#define NPCM_DMA_STATUS_TI BIT(0)
> +
> +/* Normal Interrupt Summary */
> +#define NPCM_DMA_STATUS_NIS BIT(16)
> +/* Interrupts enabled by NIE */
> +#define NPCM_DMA_STATUS_NIS_BITS (NPCM_DMA_STATUS_TI | \
> +                                  NPCM_DMA_STATUS_TU | \
> +                                  NPCM_DMA_STATUS_RI | \
> +                                  NPCM_DMA_STATUS_ERI)
> +/* Abnormal Interrupt Summary */
> +#define NPCM_DMA_STATUS_AIS BIT(15)
> +/* Interrupts enabled by AIE */
> +#define NPCM_DMA_STATUS_AIS_BITS (NPCM_DMA_STATUS_TPS | \
> +                                  NPCM_DMA_STATUS_TJT | \
> +                                  NPCM_DMA_STATUS_OVF | \
> +                                  NPCM_DMA_STATUS_UNF | \
> +                                  NPCM_DMA_STATUS_RU  | \
> +                                  NPCM_DMA_STATUS_RPS | \
> +                                  NPCM_DMA_STATUS_RWT | \
> +                                  NPCM_DMA_STATUS_ETI | \
> +                                  NPCM_DMA_STATUS_FBI)
> +
> +/* Early Receive Interrupt Enable */
> +#define NPCM_DMA_INTR_ENAB_ERE BIT(14)
> +/* Fatal Bus Error Interrupt Enable */
> +#define NPCM_DMA_INTR_ENAB_FBE BIT(13)
> +/* Early transmit Interrupt Enable */
> +#define NPCM_DMA_INTR_ENAB_ETE BIT(10)
> +/* Receive Watchdog Timout Enable */
> +#define NPCM_DMA_INTR_ENAB_RWE BIT(9)
> +/* Receive Process Stopped Enable */
> +#define NPCM_DMA_INTR_ENAB_RSE BIT(8)
> +/* Receive Buffer Unavailable Enable */
> +#define NPCM_DMA_INTR_ENAB_RUE BIT(7)
> +/* Receive Interrupt Enable */
> +#define NPCM_DMA_INTR_ENAB_RIE BIT(6)
> +/* Transmit Underflow Enable */
> +#define NPCM_DMA_INTR_ENAB_UNE BIT(5)
> +/* Receive Overflow Enable */
> +#define NPCM_DMA_INTR_ENAB_OVE BIT(4)
> +/* Transmit Jabber Timeout Enable */
> +#define NPCM_DMA_INTR_ENAB_TJE BIT(3)
> +/* Transmit Buffer Unavailable Enable */
> +#define NPCM_DMA_INTR_ENAB_TUE BIT(2)
> +/* Transmit Process Stopped Enable */
> +#define NPCM_DMA_INTR_ENAB_TSE BIT(1)
> +/* Transmit Interrupt Enable */
> +#define NPCM_DMA_INTR_ENAB_TIE BIT(0)
> +
> +/* Normal Interrupt Summary Enable */
> +#define NPCM_DMA_INTR_ENAB_NIE BIT(16)
> +/* Interrupts enabled by NIE Enable */
> +#define NPCM_DMA_INTR_ENAB_NIE_BITS (NPCM_DMA_INTR_ENAB_TIE | \
> +                                     NPCM_DMA_INTR_ENAB_TUE | \
> +                                     NPCM_DMA_INTR_ENAB_RIE | \
> +                                     NPCM_DMA_INTR_ENAB_ERE)
> +/* Abnormal Interrupt Summary Enable */
> +#define NPCM_DMA_INTR_ENAB_AIE BIT(15)
> +/* Interrupts enabled by AIE Enable */
> +#define NPCM_DMA_INTR_ENAB_AIE_BITS (NPCM_DMA_INTR_ENAB_TSE | \
> +                                     NPCM_DMA_INTR_ENAB_TJE | \
> +                                     NPCM_DMA_INTR_ENAB_OVE | \
> +                                     NPCM_DMA_INTR_ENAB_UNE | \
> +                                     NPCM_DMA_INTR_ENAB_RUE | \
> +                                     NPCM_DMA_INTR_ENAB_RSE | \
> +                                     NPCM_DMA_INTR_ENAB_RWE | \
> +                                     NPCM_DMA_INTR_ENAB_ETE | \
> +                                     NPCM_DMA_INTR_ENAB_FBE)
> +
> +/* Flushing Disabled */
> +#define NPCM_DMA_CONTROL_FLUSH_MASK BIT(24)
> +/* Start/stop Transmit */
> +#define NPCM_DMA_CONTROL_START_STOP_TX BIT(13)
> +/* Next receive descriptor start address */
> +#define NPCM_DMA_HOST_RX_DESC_MASK(word) ((uint32_t) (word) & ~3u)
> +/* Next transmit descriptor start address */
> +#define NPCM_DMA_HOST_TX_DESC_MASK(word) ((uint32_t) (word) & ~3u)
> +
> +/* Receive enable */
> +#define NPCM_GMAC_MAC_CONFIG_RX_EN BIT(2)
> +/* Transmit enable */
> +#define NPCM_GMAC_MAC_CONFIG_TX_EN BIT(3)
> +
> +/* Frame Receive All */
> +#define NPCM_GMAC_FRAME_FILTER_REC_ALL_MASK BIT(31)
> +/* Frame HPF Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_HPF_MASK BIT(10)
> +/* Frame SAF Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_SAF_MASK BIT(9)
> +/* Frame SAIF Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_SAIF_MASK BIT(8)
> +/* Frame PCF Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_PCF_MASK BIT(word) extract32((word), 6, 2)
> +/* Frame DBF Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_DBF_MASK BIT(5)
> +/* Frame PM Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_PM_MASK BIT(4)
> +/* Frame DAIF Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_DAIF_MASK BIT(3)
> +/* Frame HMC Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_HMC_MASK BIT(2)
> +/* Frame HUC Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_HUC_MASK BIT(1)
> +/* Frame PR Filter*/
> +#define NPCM_GMAC_FRAME_FILTER_PR_MASK BIT(0)
> +
>  #endif /* NPCM_GMAC_H */
> --
> 2.42.0.655.g421f12c284-goog
>
>