IPC@CHIP Documentation - SC12 @CHIP-RTOS V1.10

IPC@CHIP Documentation Index
Ethernet: Packet Driver Interface
Ethernet Packet Driver Interface - SC12 @CHIP-RTOS V1.10
Packet driver interface definition for direct access to the IPC@CHIP Ethernet device.
Packet drivers provide a simple, common programming interface that allows multiple applications to share a network interface at
the data link level. The packet driver demultiplex incoming packets among the applications by using the network media's standard
packet type. The packet driver provides calls to initiate access to a specific packet type, to end access to it, to send a packet,and to
get information about the interface. The implemented services are only a small subset of the common packet driver interface.
The IPC@CHIP RTOS uses interrupt 0xAE with a service number in the high order byte of the AX register (AH) to access the
IPC@CHIP Ethernet packet driver. All supported services are listed here.
● Interrupt_0xAE_function_0x01:_DRIVER_INFO, Get Driver Information
● Interrupt_0xAE_function_0x02:_ACCESS_TYPE, Install Access Handler
● Interrupt_0xAE_function_0x03:_RELEASE_TYPE, Unload an Access Handler
● Interrupt_0xAE_function_0x04:_SEND_PKT, Send an Ethernet packet
● Interrupt_0xAE_function_0x06:_GET_ADDRESS, Get the IPC@CHIP Ethernet address
● Interrupt_0xAE_function_0x14:_SET_RCV_MODE, Set receive mode
● Interrupt_0xAE_function_0x15:_GET_RCV_MODE, Get current receive mode
● Interrupt_0xAE_function_0x16:_SET_MULTICAST, Set Ethernet multicast address
● Interrupt_0xAE_function_0x27:_DEL_MULTICAST, Remove Ethernet multicast address
● Interrupt_0xAE_function_0x28:_INSTALL_WILDCARD, Install wildcard access handler
On return the CPU carry flag is set if an error has occurred. The DH register holds an error code:
Important:
0x00 NO_ERROR
0x01 BAD_HANDLE // Invalid handle number
0x05 BAD_TYPE // Bad packet type specified
0x09 NO_SPACE // Insufficient space
0x0A TYPE_INUSE // Type already in use
0x0B BAD_COMMAND // Command not supported
0x0C CANT_SEND // Packet couldn't be sent
// (hardware error?).
One important difference to other standard packet drivers is, that the software interrupt 0xAE does not have the typical
PKTDRVR signature at offset 3 in the interrupt source code. So instead of looking for this signature, use BIOS interrupt
0xA0 function0x16 to check if the packet driver interface is available in the IPC@CHIP @CHIP-RTOS.
The maximum number of installed packet handlers is five.
Examples for the usage of the packet interface:
1. PKTDRV.C: C-Source for the API calls
2. PKTDRV.H: Defines, typedefs, prototypes, ... for the API calls
3. REC.C : Example for a receiver handler function, installed with function ACCESS_TYPE
4. SEND.EXE and RCV.EXE (with source): Simple program pair for sending and receiving of Ethernet packets
Page 378 / 400