iPXE
Data Structures | Defines | Typedefs | Functions
nxhal_nic_interface.h File Reference

Go to the source code of this file.

Data Structures

struct  nx_rx_rule_arg_s
struct  nx_rx_rule_s
struct  nx_hostmsg_rx_rule_s
struct  nx_cardmsg_rx_rule_s
struct  nx_hostrq_cds_ring_s
struct  nx_hostrq_tx_ctx_s
struct  nx_cardrsp_cds_ring_s
struct  nx_cardrsp_tx_ctx_s
struct  nx_hostrq_sds_ring_s
struct  nx_hostrq_rds_ring_s
struct  nx_hostrq_rx_ctx_s
struct  nx_cardrsp_rds_ring_s
struct  nx_cardrsp_sds_ring_s
struct  nx_cardrsp_rx_ctx_s
struct  nx_hostrq_stat_setup_s

Defines

#define _NXHAL_NIC_INTERFACE_H_
#define NX_CDRP_SIGNATURE_TO_PCIFN(sign)   ((sign) & 0xff)
#define NX_CDRP_SIGNATURE_TO_VERSION(sign)   (((sign)>>8) & 0xff)
#define NX_CDRP_SIGNATURE_TO_MAGIC(sign)   (((sign)>>16) & 0xffff)
#define NX_CDRP_SIGNATURE_VALID(sign)
#define NX_CDRP_SIGNATURE_MAKE(pcifn, version)
#define NX_CDRP_CLEAR   0x00000000
#define NX_CDRP_CMD_BIT   0x80000000
#define NX_CDRP_FORM_RSP(rsp)   (rsp)
#define NX_CDRP_IS_RSP(rsp)   (((rsp) & NX_CDRP_CMD_BIT) == 0)
#define NX_CDRP_RSP_OK   0x00000001
#define NX_CDRP_RSP_FAIL   0x00000002
#define NX_CDRP_RSP_TIMEOUT   0x00000003
#define NX_CDRP_FORM_CMD(cmd)   (NX_CDRP_CMD_BIT | (cmd))
#define NX_CDRP_IS_CMD(cmd)   (((cmd) & NX_CDRP_CMD_BIT) != 0)
#define NX_CDRP_CMD_SUBMIT_CAPABILITIES   0x00000001
#define NX_CDRP_CMD_READ_MAX_RDS_PER_CTX   0x00000002
#define NX_CDRP_CMD_READ_MAX_SDS_PER_CTX   0x00000003
#define NX_CDRP_CMD_READ_MAX_RULES_PER_CTX   0x00000004
#define NX_CDRP_CMD_READ_MAX_RX_CTX   0x00000005
#define NX_CDRP_CMD_READ_MAX_TX_CTX   0x00000006
#define NX_CDRP_CMD_CREATE_RX_CTX   0x00000007
#define NX_CDRP_CMD_DESTROY_RX_CTX   0x00000008
#define NX_CDRP_CMD_CREATE_TX_CTX   0x00000009
#define NX_CDRP_CMD_DESTROY_TX_CTX   0x0000000a
#define NX_CDRP_CMD_SETUP_STATISTICS   0x0000000e
#define NX_CDRP_CMD_GET_STATISTICS   0x0000000f
#define NX_CDRP_CMD_DELETE_STATISTICS   0x00000010
#define NX_CDRP_CMD_MAX   0x00000011
#define NX_CAP_BIT(class, bit)   (1 << bit)
#define NX_CAP0_LEGACY_CONTEXT   NX_CAP_BIT(0, 0)
#define NX_CAP0_MULTI_CONTEXT   NX_CAP_BIT(0, 1)
#define NX_CAP0_LEGACY_MN   NX_CAP_BIT(0, 2)
#define NX_CAP0_LEGACY_MS   NX_CAP_BIT(0, 3)
#define NX_CAP0_CUT_THROUGH   NX_CAP_BIT(0, 4)
#define NX_CAP0_LRO   NX_CAP_BIT(0, 5)
#define NX_CAP0_LSO   NX_CAP_BIT(0, 6)
#define NX_CAP1_NIC   NX_CAP_BIT(1, 0)
#define NX_CAP1_PXE   NX_CAP_BIT(1, 1)
#define NX_CAP1_CHIMNEY   NX_CAP_BIT(1, 2)
#define NX_CAP1_LSA   NX_CAP_BIT(1, 3)
#define NX_CAP1_RDMA   NX_CAP_BIT(1, 4)
#define NX_CAP1_ISCSI   NX_CAP_BIT(1, 5)
#define NX_CAP1_FCOE   NX_CAP_BIT(1, 6)
#define NX_RX_RULETYPE_DEFAULT   0
#define NX_RX_RULETYPE_MAC   1
#define NX_RX_RULETYPE_MAC_VLAN   2
#define NX_RX_RULETYPE_MAC_RSS   3
#define NX_RX_RULETYPE_MAC_VLAN_RSS   4
#define NX_RX_RULETYPE_MAX   5
#define NX_RX_RULECMD_ADD   0
#define NX_RX_RULECMD_REMOVE   1
#define NX_RX_RULECMD_MAX   2
#define NX_HOST_CTX_STATE_FREED   0 /* Invalid state */
#define NX_HOST_CTX_STATE_ALLOCATED   1 /* Not committed */
#define NX_HOST_CTX_STATE_ACTIVE   2
#define NX_HOST_CTX_STATE_DISABLED   3
#define NX_HOST_CTX_STATE_QUIESCED   4
#define NX_HOST_CTX_STATE_MAX   5
#define NX_HOST_INT_CRB_MODE_UNIQUE   0
#define NX_HOST_INT_CRB_MODE_SHARED   1 /* <= LEGACY */
#define NX_HOST_INT_CRB_MODE_NORX   2
#define NX_HOST_INT_CRB_MODE_NOTX   3
#define NX_HOST_INT_CRB_MODE_NORXTX   4
#define NX_DESTROY_CTX_RESET   0
#define NX_DESTROY_CTX_D3_RESET   1
#define NX_DESTROY_CTX_MAX   2
#define SIZEOF_HOSTRQ_TX(HOSTRQ_TX)   ( sizeof(HOSTRQ_TX))
#define SIZEOF_CARDRSP_TX(CARDRSP_TX)   ( sizeof(CARDRSP_TX))
#define NX_HOST_RDS_CRB_MODE_UNIQUE   0 /* <= LEGACY */
#define NX_HOST_RDS_CRB_MODE_SHARED   1
#define NX_HOST_RDS_CRB_MODE_CUSTOM   2
#define NX_HOST_RDS_CRB_MODE_MAX   3
#define NX_RDS_RING_TYPE_NORMAL   0
#define NX_RDS_RING_TYPE_JUMBO   1
#define NX_RDS_RING_TYPE_LRO   2
#define NX_RDS_RING_TYPE_MAX   3
#define SIZEOF_HOSTRQ_RX(HOSTRQ_RX, rds_rings, sds_rings)
#define SIZEOF_CARDRSP_RX(CARDRSP_RX, rds_rings, sds_rings)
#define NX_STATISTICS_MODE_INVALID   0
#define NX_STATISTICS_MODE_PULL   1
#define NX_STATISTICS_MODE_PUSH   2
#define NX_STATISTICS_MODE_SINGLE_SHOT   3
#define NX_STATISTICS_MODE_MAX   4
#define NX_STATISTICS_TYPE_INVALID   0
#define NX_STATISTICS_TYPE_NIC_RX_CORE   1
#define NX_STATISTICS_TYPE_NIC_TX_CORE   2
#define NX_STATISTICS_TYPE_NIC_RX_ALL   3
#define NX_STATISTICS_TYPE_NIC_TX_ALL   4
#define NX_STATISTICS_TYPE_MAX   5

Typedefs

typedef U32 nx_reg_addr_t
typedef U32 nx_rx_rule_type_t
typedef U32 nx_rx_rule_cmd_t
typedef struct nx_rx_rule_arg_s nx_rx_rule_arg_t
typedef struct nx_rx_rule_s nx_rx_rule_t
typedef struct nx_hostmsg_rx_rule_s nx_hostmsg_rx_rule_t
typedef struct nx_cardmsg_rx_rule_s nx_cardmsg_rx_rule_t
typedef U32 nx_host_ctx_state_t
typedef struct nx_hostrq_cds_ring_s nx_hostrq_cds_ring_t
typedef struct nx_hostrq_tx_ctx_s nx_hostrq_tx_ctx_t
typedef struct
nx_cardrsp_cds_ring_s 
nx_cardrsp_cds_ring_t
typedef struct nx_cardrsp_tx_ctx_s nx_cardrsp_tx_ctx_t
typedef struct nx_hostrq_sds_ring_s nx_hostrq_sds_ring_t
typedef struct nx_hostrq_rds_ring_s nx_hostrq_rds_ring_t
typedef struct nx_hostrq_rx_ctx_s nx_hostrq_rx_ctx_t
typedef struct
nx_cardrsp_rds_ring_s 
nx_cardrsp_rds_ring_t
typedef struct
nx_cardrsp_sds_ring_s 
nx_cardrsp_sds_ring_t
typedef struct nx_cardrsp_rx_ctx_s nx_cardrsp_rx_ctx_t
typedef struct
nx_hostrq_stat_setup_s 
nx_hostrq_stat_setup_t

Functions

 FILE_LICENCE (GPL2_ONLY)

Define Documentation

Definition at line 9 of file nxhal_nic_interface.h.

#define NX_CDRP_SIGNATURE_TO_PCIFN (   sign)    ((sign) & 0xff)

Definition at line 82 of file nxhal_nic_interface.h.

#define NX_CDRP_SIGNATURE_TO_VERSION (   sign)    (((sign)>>8) & 0xff)

Definition at line 83 of file nxhal_nic_interface.h.

#define NX_CDRP_SIGNATURE_TO_MAGIC (   sign)    (((sign)>>16) & 0xffff)

Definition at line 84 of file nxhal_nic_interface.h.

#define NX_CDRP_SIGNATURE_VALID (   sign)
Value:
( NX_CDRP_SIGNATURE_TO_MAGIC(sign) == 0xcafe && \
          NX_CDRP_SIGNATURE_TO_PCIFN(sign) < 8)

Definition at line 85 of file nxhal_nic_interface.h.

#define NX_CDRP_SIGNATURE_MAKE (   pcifn,
  version 
)
Value:
( ((pcifn) & 0xff) |                  \
          (((version) & 0xff) << 8) |         \
          (0xcafe << 16) )

Definition at line 88 of file nxhal_nic_interface.h.

Referenced by phantom_issue_cmd().

#define NX_CDRP_CLEAR   0x00000000

Definition at line 93 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_BIT   0x80000000

Definition at line 94 of file nxhal_nic_interface.h.

#define NX_CDRP_FORM_RSP (   rsp)    (rsp)

Definition at line 98 of file nxhal_nic_interface.h.

Referenced by phantom_wait_for_cmd().

#define NX_CDRP_IS_RSP (   rsp)    (((rsp) & NX_CDRP_CMD_BIT) == 0)

Definition at line 99 of file nxhal_nic_interface.h.

Referenced by phantom_wait_for_cmd().

#define NX_CDRP_RSP_OK   0x00000001

Definition at line 101 of file nxhal_nic_interface.h.

Referenced by phantom_wait_for_cmd().

#define NX_CDRP_RSP_FAIL   0x00000002

Definition at line 102 of file nxhal_nic_interface.h.

Referenced by phantom_wait_for_cmd().

#define NX_CDRP_RSP_TIMEOUT   0x00000003

Definition at line 103 of file nxhal_nic_interface.h.

Referenced by phantom_wait_for_cmd().

#define NX_CDRP_FORM_CMD (   cmd)    (NX_CDRP_CMD_BIT | (cmd))

Definition at line 109 of file nxhal_nic_interface.h.

Referenced by phantom_issue_cmd().

#define NX_CDRP_IS_CMD (   cmd)    (((cmd) & NX_CDRP_CMD_BIT) != 0)

Definition at line 110 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_SUBMIT_CAPABILITIES   0x00000001

Definition at line 113 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_READ_MAX_RDS_PER_CTX   0x00000002

Definition at line 116 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_READ_MAX_SDS_PER_CTX   0x00000003

Definition at line 119 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_READ_MAX_RULES_PER_CTX   0x00000004

Definition at line 122 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_READ_MAX_RX_CTX   0x00000005

Definition at line 125 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_READ_MAX_TX_CTX   0x00000006

Definition at line 128 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_CREATE_RX_CTX   0x00000007

Definition at line 131 of file nxhal_nic_interface.h.

Referenced by phantom_create_rx_ctx().

#define NX_CDRP_CMD_DESTROY_RX_CTX   0x00000008

Definition at line 134 of file nxhal_nic_interface.h.

Referenced by phantom_destroy_rx_ctx().

#define NX_CDRP_CMD_CREATE_TX_CTX   0x00000009

Definition at line 137 of file nxhal_nic_interface.h.

Referenced by phantom_create_tx_ctx().

#define NX_CDRP_CMD_DESTROY_TX_CTX   0x0000000a

Definition at line 140 of file nxhal_nic_interface.h.

Referenced by phantom_destroy_tx_ctx().

#define NX_CDRP_CMD_SETUP_STATISTICS   0x0000000e

Definition at line 143 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_GET_STATISTICS   0x0000000f

Definition at line 146 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_DELETE_STATISTICS   0x00000010

Definition at line 149 of file nxhal_nic_interface.h.

#define NX_CDRP_CMD_MAX   0x00000011

Definition at line 151 of file nxhal_nic_interface.h.

#define NX_CAP_BIT (   class,
  bit 
)    (1 << bit)

Definition at line 157 of file nxhal_nic_interface.h.

#define NX_CAP0_LEGACY_CONTEXT   NX_CAP_BIT(0, 0)

Definition at line 161 of file nxhal_nic_interface.h.

Referenced by phantom_create_rx_ctx(), and phantom_create_tx_ctx().

#define NX_CAP0_MULTI_CONTEXT   NX_CAP_BIT(0, 1)

Definition at line 162 of file nxhal_nic_interface.h.

#define NX_CAP0_LEGACY_MN   NX_CAP_BIT(0, 2)

Definition at line 163 of file nxhal_nic_interface.h.

Referenced by phantom_create_rx_ctx(), and phantom_create_tx_ctx().

#define NX_CAP0_LEGACY_MS   NX_CAP_BIT(0, 3)

Definition at line 164 of file nxhal_nic_interface.h.

#define NX_CAP0_CUT_THROUGH   NX_CAP_BIT(0, 4)

Definition at line 165 of file nxhal_nic_interface.h.

#define NX_CAP0_LRO   NX_CAP_BIT(0, 5)

Definition at line 166 of file nxhal_nic_interface.h.

#define NX_CAP0_LSO   NX_CAP_BIT(0, 6)

Definition at line 167 of file nxhal_nic_interface.h.

#define NX_CAP1_NIC   NX_CAP_BIT(1, 0)

Definition at line 171 of file nxhal_nic_interface.h.

#define NX_CAP1_PXE   NX_CAP_BIT(1, 1)

Definition at line 172 of file nxhal_nic_interface.h.

#define NX_CAP1_CHIMNEY   NX_CAP_BIT(1, 2)

Definition at line 173 of file nxhal_nic_interface.h.

#define NX_CAP1_LSA   NX_CAP_BIT(1, 3)

Definition at line 174 of file nxhal_nic_interface.h.

#define NX_CAP1_RDMA   NX_CAP_BIT(1, 4)

Definition at line 175 of file nxhal_nic_interface.h.

#define NX_CAP1_ISCSI   NX_CAP_BIT(1, 5)

Definition at line 176 of file nxhal_nic_interface.h.

#define NX_CAP1_FCOE   NX_CAP_BIT(1, 6)

Definition at line 177 of file nxhal_nic_interface.h.

#define NX_RX_RULETYPE_DEFAULT   0

Definition at line 188 of file nxhal_nic_interface.h.

#define NX_RX_RULETYPE_MAC   1

Definition at line 189 of file nxhal_nic_interface.h.

#define NX_RX_RULETYPE_MAC_VLAN   2

Definition at line 190 of file nxhal_nic_interface.h.

#define NX_RX_RULETYPE_MAC_RSS   3

Definition at line 191 of file nxhal_nic_interface.h.

Definition at line 192 of file nxhal_nic_interface.h.

#define NX_RX_RULETYPE_MAX   5

Definition at line 193 of file nxhal_nic_interface.h.

#define NX_RX_RULECMD_ADD   0

Definition at line 197 of file nxhal_nic_interface.h.

#define NX_RX_RULECMD_REMOVE   1

Definition at line 198 of file nxhal_nic_interface.h.

#define NX_RX_RULECMD_MAX   2

Definition at line 199 of file nxhal_nic_interface.h.

#define NX_HOST_CTX_STATE_FREED   0 /* Invalid state */

Definition at line 256 of file nxhal_nic_interface.h.

#define NX_HOST_CTX_STATE_ALLOCATED   1 /* Not committed */

Definition at line 257 of file nxhal_nic_interface.h.

#define NX_HOST_CTX_STATE_ACTIVE   2

Definition at line 259 of file nxhal_nic_interface.h.

Definition at line 260 of file nxhal_nic_interface.h.

Definition at line 261 of file nxhal_nic_interface.h.

#define NX_HOST_CTX_STATE_MAX   5

Definition at line 262 of file nxhal_nic_interface.h.

Definition at line 270 of file nxhal_nic_interface.h.

#define NX_HOST_INT_CRB_MODE_SHARED   1 /* <= LEGACY */

Definition at line 272 of file nxhal_nic_interface.h.

Referenced by phantom_create_rx_ctx(), and phantom_create_tx_ctx().

#define NX_HOST_INT_CRB_MODE_NORX   2

Definition at line 274 of file nxhal_nic_interface.h.

#define NX_HOST_INT_CRB_MODE_NOTX   3

Definition at line 276 of file nxhal_nic_interface.h.

Definition at line 278 of file nxhal_nic_interface.h.

#define NX_DESTROY_CTX_RESET   0

Definition at line 284 of file nxhal_nic_interface.h.

Referenced by phantom_destroy_rx_ctx(), and phantom_destroy_tx_ctx().

#define NX_DESTROY_CTX_D3_RESET   1

Definition at line 285 of file nxhal_nic_interface.h.

#define NX_DESTROY_CTX_MAX   2

Definition at line 286 of file nxhal_nic_interface.h.

#define SIZEOF_HOSTRQ_TX (   HOSTRQ_TX)    ( sizeof(HOSTRQ_TX))

Definition at line 333 of file nxhal_nic_interface.h.

#define SIZEOF_CARDRSP_TX (   CARDRSP_TX)    ( sizeof(CARDRSP_TX))

Definition at line 336 of file nxhal_nic_interface.h.

#define NX_HOST_RDS_CRB_MODE_UNIQUE   0 /* <= LEGACY */

Definition at line 348 of file nxhal_nic_interface.h.

Referenced by phantom_create_rx_ctx().

Definition at line 354 of file nxhal_nic_interface.h.

Definition at line 359 of file nxhal_nic_interface.h.

#define NX_HOST_RDS_CRB_MODE_MAX   3

Definition at line 360 of file nxhal_nic_interface.h.

#define NX_RDS_RING_TYPE_NORMAL   0

Definition at line 367 of file nxhal_nic_interface.h.

Referenced by phantom_create_rx_ctx().

#define NX_RDS_RING_TYPE_JUMBO   1

Definition at line 368 of file nxhal_nic_interface.h.

#define NX_RDS_RING_TYPE_LRO   2

Definition at line 369 of file nxhal_nic_interface.h.

#define NX_RDS_RING_TYPE_MAX   3

Definition at line 370 of file nxhal_nic_interface.h.

#define SIZEOF_HOSTRQ_RX (   HOSTRQ_RX,
  rds_rings,
  sds_rings 
)
Value:
( sizeof(HOSTRQ_RX) +                                   \
        (rds_rings)*(sizeof (nx_hostrq_rds_ring_t)) +           \
        (sds_rings)*(sizeof (nx_hostrq_sds_ring_t)) )

Definition at line 440 of file nxhal_nic_interface.h.

#define SIZEOF_CARDRSP_RX (   CARDRSP_RX,
  rds_rings,
  sds_rings 
)
Value:
( sizeof(CARDRSP_RX) +                                  \
        (rds_rings)*(sizeof (nx_cardrsp_rds_ring_t)) +          \
        (sds_rings)*(sizeof (nx_cardrsp_sds_ring_t)) )

Definition at line 445 of file nxhal_nic_interface.h.

Definition at line 459 of file nxhal_nic_interface.h.

#define NX_STATISTICS_MODE_PULL   1

Definition at line 463 of file nxhal_nic_interface.h.

#define NX_STATISTICS_MODE_PUSH   2

Definition at line 467 of file nxhal_nic_interface.h.

Definition at line 470 of file nxhal_nic_interface.h.

#define NX_STATISTICS_MODE_MAX   4

Definition at line 472 of file nxhal_nic_interface.h.

Definition at line 477 of file nxhal_nic_interface.h.

Definition at line 478 of file nxhal_nic_interface.h.

Definition at line 479 of file nxhal_nic_interface.h.

Definition at line 480 of file nxhal_nic_interface.h.

Definition at line 481 of file nxhal_nic_interface.h.

#define NX_STATISTICS_TYPE_MAX   5

Definition at line 482 of file nxhal_nic_interface.h.


Typedef Documentation

typedef U32 nx_reg_addr_t

Definition at line 15 of file nxhal_nic_interface.h.

Definition at line 186 of file nxhal_nic_interface.h.

Definition at line 195 of file nxhal_nic_interface.h.

typedef struct nx_rx_rule_s nx_rx_rule_t

Definition at line 254 of file nxhal_nic_interface.h.


Function Documentation

FILE_LICENCE ( GPL2_ONLY  )