MnpImpl.h

Go to the documentation of this file.

 
#ifndef _MNP_IMPL_H_
#define _MNP_IMPL_H_
 
#include "MnpDriver.h"
 
#define NET_ETHER_FCS_SIZE  4
 
#define MNP_SYS_POLL_INTERVAL        (10 * TICKS_PER_MS)    // 10 milliseconds
#define MNP_TIMEOUT_CHECK_INTERVAL   (50 * TICKS_PER_MS)    // 50 milliseconds
#define MNP_MEDIA_DETECT_INTERVAL    (500 * TICKS_PER_MS)   // 500 milliseconds
#define MNP_TX_TIMEOUT_TIME          (500 * TICKS_PER_MS)   // 500 milliseconds
#define MNP_INIT_NET_BUFFER_NUM      512
#define MNP_NET_BUFFER_INCREASEMENT  64
#define MNP_MAX_NET_BUFFER_NUM       65536
#define MNP_TX_BUFFER_INCREASEMENT   32     // Same as the recycling Q length for xmit_done in UNDI command.
#define MNP_MAX_TX_BUFFER_NUM        65536
 
#define MNP_MAX_RCVD_PACKET_QUE_SIZE  256
 
#define MNP_RECEIVE_UNICAST    0x01
#define MNP_RECEIVE_BROADCAST  0x02
 
#define UNICAST_PACKET    MNP_RECEIVE_UNICAST
#define BROADCAST_PACKET  MNP_RECEIVE_BROADCAST
 
#define MNP_INSTANCE_DATA_SIGNATURE  SIGNATURE_32 ('M', 'n', 'p', 'I')
 
#define MNP_INSTANCE_DATA_FROM_THIS(a) \
  CR ( \
  (a), \
  MNP_INSTANCE_DATA, \
  ManagedNetwork, \
  MNP_INSTANCE_DATA_SIGNATURE \
  )
 
typedef struct {
  UINT32                             Signature;
 
  MNP_SERVICE_DATA                   *MnpServiceData;
 
  EFI_HANDLE                         Handle;
 
  LIST_ENTRY                         InstEntry;
 
  EFI_MANAGED_NETWORK_PROTOCOL       ManagedNetwork;
 
  BOOLEAN                            Configured;
  BOOLEAN                            Destroyed;
 
  LIST_ENTRY                         GroupCtrlBlkList;
 
  NET_MAP                            RxTokenMap;
 
  LIST_ENTRY                         RxDeliveredPacketQueue;
  LIST_ENTRY                         RcvdPacketQueue;
  UINTN                              RcvdPacketQueueSize;
 
  EFI_MANAGED_NETWORK_CONFIG_DATA    ConfigData;
 
  UINT8                              ReceiveFilter;
} MNP_INSTANCE_DATA;
 
typedef struct {
  LIST_ENTRY         AddrEntry;
  EFI_MAC_ADDRESS    Address;
  INTN               RefCnt;
} MNP_GROUP_ADDRESS;
 
typedef struct {
  LIST_ENTRY           CtrlBlkEntry;
  MNP_GROUP_ADDRESS    *GroupAddress;
} MNP_GROUP_CONTROL_BLOCK;
 
typedef struct {
  LIST_ENTRY                          WrapEntry;
  MNP_INSTANCE_DATA                   *Instance;
  EFI_MANAGED_NETWORK_RECEIVE_DATA    RxData;
  NET_BUF                             *Nbuf;
  UINT64                              TimeoutTick;
} MNP_RXDATA_WRAP;
 
#define MNP_TX_BUF_WRAP_SIGNATURE  SIGNATURE_32 ('M', 'T', 'B', 'W')
 
typedef struct {
  UINT32        Signature;
  LIST_ENTRY    WrapEntry;            // Link to FreeTxBufList
  LIST_ENTRY    AllEntry;             // Link to AllTxBufList
  BOOLEAN       InUse;
  UINT8         TxBuf[1];
} MNP_TX_BUF_WRAP;
 
EFI_STATUS
MnpInitializeDeviceData (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData,
  IN     EFI_HANDLE       ImageHandle,
  IN     EFI_HANDLE       ControllerHandle
  );
 
VOID
MnpDestroyDeviceData (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData,
  IN     EFI_HANDLE       ImageHandle
  );
 
MNP_SERVICE_DATA *
MnpCreateServiceData (
  IN MNP_DEVICE_DATA  *MnpDeviceData,
  IN UINT16           VlanId,
  IN UINT8            Priority OPTIONAL
  );
 
EFI_STATUS
MnpInitializeServiceData (
  IN OUT MNP_SERVICE_DATA  *MnpServiceData,
  IN     EFI_HANDLE        ImageHandle,
  IN     EFI_HANDLE        ControllerHandle
  );
 
EFI_STATUS
MnpDestroyServiceData (
  IN OUT MNP_SERVICE_DATA  *MnpServiceData
  );
 
EFI_STATUS
MnpDestroyServiceChild (
  IN OUT MNP_SERVICE_DATA  *MnpServiceData
  );
 
MNP_SERVICE_DATA *
MnpFindServiceData (
  IN MNP_DEVICE_DATA  *MnpDeviceData,
  IN UINT16           VlanId
  );
 
VOID
MnpInitializeInstanceData (
  IN     MNP_SERVICE_DATA   *MnpServiceData,
  IN OUT MNP_INSTANCE_DATA  *Instance
  );
 
EFI_STATUS
EFIAPI
MnpTokenExist (
  IN NET_MAP       *Map,
  IN NET_MAP_ITEM  *Item,
  IN VOID          *Arg
  );
 
EFI_STATUS
EFIAPI
MnpCancelTokens (
  IN OUT NET_MAP       *Map,
  IN OUT NET_MAP_ITEM  *Item,
  IN     VOID          *Arg
  );
 
VOID
MnpFlushRcvdDataQueue (
  IN OUT MNP_INSTANCE_DATA  *Instance
  );
 
EFI_STATUS
MnpConfigureInstance (
  IN OUT MNP_INSTANCE_DATA                *Instance,
  IN     EFI_MANAGED_NETWORK_CONFIG_DATA  *ConfigData OPTIONAL
  );
 
EFI_STATUS
MnpGroupOp (
  IN OUT MNP_INSTANCE_DATA        *Instance,
  IN     BOOLEAN                  JoinFlag,
  IN     EFI_MAC_ADDRESS          *MacAddress OPTIONAL,
  IN     MNP_GROUP_CONTROL_BLOCK  *CtrlBlk OPTIONAL
  );
 
BOOLEAN
MnpIsValidTxToken (
  IN MNP_INSTANCE_DATA                     *Instance,
  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
MnpBuildTxPacket (
  IN     MNP_SERVICE_DATA                   *MnpServiceData,
  IN     EFI_MANAGED_NETWORK_TRANSMIT_DATA  *TxData,
  OUT UINT8                                 **PktBuf,
  OUT UINT32                                *PktLen
  );
 
EFI_STATUS
MnpSyncSendPacket (
  IN     MNP_SERVICE_DATA                      *MnpServiceData,
  IN     UINT8                                 *Packet,
  IN     UINT32                                Length,
  IN OUT EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
MnpInstanceDeliverPacket (
  IN OUT MNP_INSTANCE_DATA  *Instance
  );
 
VOID
EFIAPI
MnpRecycleRxData (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
MnpReceivePacket (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData
  );
 
NET_BUF *
MnpAllocNbuf (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData
  );
 
VOID
MnpFreeNbuf (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData,
  IN OUT NET_BUF          *Nbuf
  );
 
UINT8 *
MnpAllocTxBuf (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData
  );
 
EFI_STATUS
MnpRecycleTxBuf (
  IN OUT MNP_DEVICE_DATA  *MnpDeviceData
  );
 
VOID
EFIAPI
MnpCheckPacketTimeout (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
VOID
EFIAPI
MnpCheckMediaStatus (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
VOID
EFIAPI
MnpSystemPoll (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
EFIAPI
MnpGetModeData (
  IN     EFI_MANAGED_NETWORK_PROTOCOL  *This,
  OUT EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData OPTIONAL,
  OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData OPTIONAL
  );
 
EFI_STATUS
EFIAPI
MnpConfigure (
  IN EFI_MANAGED_NETWORK_PROTOCOL     *This,
  IN EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData OPTIONAL
  );
 
EFI_STATUS
EFIAPI
MnpMcastIpToMac (
  IN     EFI_MANAGED_NETWORK_PROTOCOL  *This,
  IN     BOOLEAN                       Ipv6Flag,
  IN     EFI_IP_ADDRESS                *IpAddress,
  OUT EFI_MAC_ADDRESS                  *MacAddress
  );
 
EFI_STATUS
EFIAPI
MnpGroups (
  IN EFI_MANAGED_NETWORK_PROTOCOL  *This,
  IN BOOLEAN                       JoinFlag,
  IN EFI_MAC_ADDRESS               *MacAddress OPTIONAL
  );
 
EFI_STATUS
EFIAPI
MnpTransmit (
  IN EFI_MANAGED_NETWORK_PROTOCOL          *This,
  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
MnpCancel (
  IN EFI_MANAGED_NETWORK_PROTOCOL          *This,
  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token OPTIONAL
  );
 
EFI_STATUS
EFIAPI
MnpReceive (
  IN EFI_MANAGED_NETWORK_PROTOCOL          *This,
  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
MnpPoll (
  IN EFI_MANAGED_NETWORK_PROTOCOL  *This
  );
 
EFI_STATUS
MnpConfigReceiveFilters (
  IN MNP_DEVICE_DATA  *MnpDeviceData
  );
 
#endif