home *** CD-ROM | disk | FTP | other *** search
/ C/C++ User's Journal & Wi…eveloper's Journal Tools / C-C__Users_Journal_and_Windows_Developers_Journal_Tools_1997.iso / sysembed / pdi.elh < prev    next >
Text File  |  1995-03-30  |  7KB  |  190 lines
  1. [ 2. Physical Driver Interface]
  2.               EMBEDDED LAN PHYSICAL DRIVER INTERFACE (PDI)
  3. ═════════════════════════════════════════════════════════════════════════
  4. The Embedded LAN Physical Driver Interface (PDI) is an interface your
  5. applications can use to directly drive the LAN interface at the packet
  6. level.  You supply all the headers and all the data.  PDI transports
  7. the packets your application sends to one or more destination machines.
  8. PDI also provides a unique "indication-based" packet reception system
  9. that lets you register a C function to be executed whenever a packet
  10. arrives for your application.
  11.  
  12. QUALITY OF SERVICE CONTROLS:
  13.  
  14. PDI also supports the Embedded LAN quality-of-service options.  For
  15. example, your application can specify that it wants to use connection-
  16. oriented services (point-to-point or modem links), connectionless
  17. services (true local area networking, such as Ethernet), or receive
  18. directed, multicast, or broadcast packets on the LAN.  PDI can even
  19. receive all packets in a special "promiscuous mode" so that your
  20. application can watch all traffic on the LAN.
  21.  
  22. PHYSICAL DRIVER INTERFACE API:
  23.  
  24. API PdiOpenEndpoint (
  25.     IN UCHAR * DriverName,                  // ASCIIZ name of NIC.
  26.     IN OUT PPHYSICAL_ADDRESS LocalAddress,  // psap, telno, etc.
  27.     IN PDIBITMASK QualityOfService,         // service bitflags.
  28.     IN PVOID Context,                       // indication token.
  29.     OUT PPDIHANDLE Handle);                 // handle assigned by PDI.
  30.  
  31. API PdiCloseEndpoint (
  32.     IN PDIHANDLE Handle);
  33.  
  34. API PdiConnect (
  35.     IN PDIHANDLE Handle,                    // handle to endpoint.
  36.     IN PPHYSICAL_ADDRESS RemoteAddress);    // partner psap, telno.
  37.  
  38. API PdiDisconnect (
  39.     IN PDIHANDLE Handle,
  40.     IN PDIBITMASK Flags);
  41.  
  42. #define PDI_DISCONNECT_ORDERLY_RELEASE  0x0001 // discon sends complete.
  43. #define PDI_DISCONNECT_ABORT            0x0002 // abort connection.
  44.  
  45. API PdiSend (
  46.     IN PDIHANDLE Handle,
  47.     IN PDIBITMASK Flags,
  48.     IN PVOID Buffer,
  49.     IN USHORT BufferLength);
  50.  
  51. #define PDI_SEND_FLAGS_EOR              0x0001  // PDU's end of record.
  52.  
  53. API PdiQueryInformation (
  54.     IN PDIHANDLE Handle,
  55.     IN USHORT InformationType,
  56.     OUT PVOID Buffer,
  57.     IN USHORT BufferLength);
  58.  
  59. #define PDI_INFO_REMOTE_ADDRESS         0 // remote transport address.
  60. #define PDI_INFO_LOCAL_ADDRESS          1 // local transport address.
  61. #define PDI_INFO_ENDPOINT_STATISTICS    2 // statistics about endpoint.
  62. #define PDI_INFO_CONNECTION_STATISTICS  3 // statistics about connection.
  63. #define PDI_INFO_PROVIDER_STATISTICS    4 // provider characteristics.
  64.  
  65. typedef struct _PHYSICAL_HARDWARE {
  66.     USHORT HardwareType;
  67. } PHYSICAL_HARDWARE, *PPHYSICAL_HARDWARE;
  68.  
  69. #define PHYSICAL_HARDWARE_TYPE_UNKNOWN  0 // hardware type not known.
  70. #define PHYSICAL_HARDWARE_TYPE_802_3    1 // IEEE 802.3 (Ethernet).
  71. #define PHYSICAL_HARDWARE_TYPE_BLUE     2 // Xerox Ethernet.
  72. #define PHYSICAL_HARDWARE_TYPE_802_4    3 // IEEE 802.4/Arcnet (Token Bus).
  73. #define PHYSICAL_HARDWARE_TYPE_802_5    4 // IEEE 802.5 (Token Ring).
  74.  
  75. typedef struct _PHYSICAL_STATISTICS {
  76.  
  77.     //
  78.     // Data throughput information.
  79.     //
  80.  
  81.     QUADINT Sends;                      // count of PdiSend requests.
  82.     QUADINT BytesSent;                  // # bytes sent through PdiSend.
  83.     QUADINT ReceiveIndications;         // # receive indications delivered.
  84.     QUADINT BytesReceived;              // # bytes delivered through recv ind's.
  85.  
  86.     //
  87.     // Error & packet type information.
  88.     //
  89.  
  90.     QUADINT ReceiveErrors;              // packets dropped in MAC/card.
  91.     QUADINT OversizePackets;            // oversized packets received.
  92.     QUADINT UndersizePackets;           // undersized packets received.
  93.     QUADINT MulticastPackets;           // multicast packets received.
  94.     QUADINT BroadcastPackets;           // broadcast packets received.
  95.     QUADINT FunctionalPackets;          // functional packets received.
  96.  
  97.     //
  98.     // Connection information.
  99.     //
  100.  
  101.     QUADINT ConnectIndications;         // count of connection indications.
  102.     QUADINT DisconnectIndications;      // count of disconnection indications.
  103.     QUADINT StatusIndications;          // count of status indications.
  104.     QUADINT ConnectionsInitiated;       // connections started at endpoint.
  105.     QUADINT ConnectionsAccepted;        // connections started from remote.
  106.  
  107.     //
  108.     // Control information.
  109.     //
  110.  
  111.     ULONG PriorityLevel;                // priority of this endpoint/connection.
  112.     ULONG SecurityLevel;                // security level/this endpoint/connection.
  113.     ULONG SecurityCompartment;          // compartment for some protocols.
  114. } PHYSICAL_STATISTICS, *PPHYSICAL_STATISTICS;
  115.  
  116. typedef union _PDI_INFORMATION_BUFFER {
  117.     PHYSICAL_ADDRESS LocalAddress;
  118.     PHYSICAL_ADDRESS RemoteAddress;
  119.     PHYSICAL_STATISTICS EndpointStatistics;
  120.     PHYSICAL_STATISTICS ConnectionStatistics;
  121.     PHYSICAL_STATISTICS ProviderStatistics;
  122. } PDI_INFORMATION_BUFFER, *PPDI_INFORMATION_BUFFER;
  123.  
  124. API PdiSetInformation (
  125.     IN PDIHANDLE Handle,
  126.     IN USHORT InformationType,
  127.     IN PVOID Buffer,
  128.     IN USHORT BufferLength);
  129.  
  130. API PdiSetIndicationHandler (
  131.     IN PDIHANDLE Handle,
  132.     IN USHORT PdiIndType,
  133.     IN PPDI_INDICATION IndicationHandler);
  134.  
  135. #define PDI_IND_RECEIVE                 0       // connection-oriented receive.
  136. #define PDI_IND_STATUS                  1       // status indication.
  137. #define PDI_IND_CONNECT                 2       // connection request.
  138. #define PDI_IND_DISCONNECT              3       // disconnection request.
  139.  
  140. //
  141. // Physical Driver Interface (PDI) indication routine (user supplied) types.
  142. //
  143.  
  144. //
  145. // Connection-oriented receive indication handler.
  146. //
  147.  
  148. typedef VOID (*PIND_PDIRECEIVE)(
  149.     IN PVOID EndpointContext,
  150.     IN PDIBITMASK ReceiveFlags,
  151.     IN PVOID Buffer,
  152.     IN USHORT BufferLength);
  153.  
  154. #define PDI_RECEIVE_OVERSIZE    0x0001  // PDU was oversized for media.
  155. #define PDI_RECEIVE_UNDERSIZE   0x0002  // PDU was too short for media.
  156. #define PDI_RECEIVE_DATA_ERROR  0x0004  // PDU had CRC or data error.
  157. #define PDI_RECEIVE_EOR         0x0008  // PDU end of record encountered.
  158. #define PDI_RECEIVE_BROADCAST   0x0010  // PDU was broadcast to all nodes.
  159. #define PDI_RECEIVE_MULTICAST   0x0020  // PDU was multicast to all nodes.
  160.  
  161. //
  162. // Change in endpoint status indication handler.
  163. //
  164.  
  165. typedef VOID (*PIND_PDISTATUS)(
  166.     IN PVOID EndpointContext,
  167.     IN PDIBITMASK StatusFlags,
  168.     IN PVOID Buffer,
  169.     IN USHORT BufferLength);
  170.  
  171. #define PDI_STATUS_IDLE         0x0000  // endpoint is idle.
  172. #define PDI_STATUS_CONNECTION   0x0001  // a connection is active.
  173.  
  174. //
  175. // Connection request indication handler.
  176. //
  177.  
  178. typedef VOID (*PIND_PDICONNECT)(
  179.     IN PVOID EndpointContext,
  180.     IN PPHYSICAL_ADDRESS RemoteAddress,
  181.     OUT PVOID *ConnectionContext);
  182.  
  183. //
  184. // Disconnection notification indication handler.
  185. //
  186.  
  187. typedef VOID (*PIND_PDIDISCONNECT)(
  188.     IN PVOID EndpointContext,
  189.     IN PDIBITMASK DisconnectFlags);
  190.