1.1.1.4 Library Interface
PLC PHY driver library provides the following interfaces:
Functions
| Name | Description |
|---|---|
| DRV_PLC_PHY_Initialize | Initializes the PLC PHY instance for the specified driver index |
| DRV_PLC_PHY_Open | Opens the specified PLC PHY driver instance and returns a handle to it |
| DRV_PLC_PHY_Close | Closes an opened instance of the PLC PHY driver given its handle |
| DRV_PLC_PHY_TxRequest | Allows a client to transmit PLC PHY data through Power Line |
| DRV_PLC_PHY_PIBGet | Allows a client to get information from PLC transceiver about PLC PHY and PHY information base (PIB) |
| DRV_PLC_PHY_PIBSet | Allows a client to set information to PLC transceiver on PLC PHY and PHY information base (PIB) |
| DRV_PLC_PHY_TxCfmCallbackRegister | Allows a client to set a data confirm event handling function for the driver to call back when the requested transmission has finished |
| DRV_PLC_PHY_DataIndCallbackRegister | Allows a client to set a data indication event handling function for the driver to call back when a data reception has finished |
| DRV_PLC_PHY_SleepDisableCallbackRegister | Allows a client to set an sleep mode disable event handling function for the driver to call back when the PLC driver is active again |
| DRV_PLC_PHY_ExceptionCallbackRegister | Allows a client to set an exception event handling function for the driver to call back when some error occurs through PLC transceiver communication |
| DRV_PLC_PHY_ExternalInterruptHandler | Allows application to register callback for PLC Interrupt pin |
| DRV_PLC_PHY_Status | Gets the current status of the PLC driver module |
| DRV_PLC_PHY_Tasks | Maintains the driver's state machine |
| DRV_PLC_PHY_Sleep | PLC driver Sleep mode management |
| DRV_PLC_PHY_EnableTX | Enables/Disables PLC transmission |
Data types and constants
| Name | Type | Description |
|---|---|---|
| DRV_PLC_PHY_TX_CFM_CALLBACK | Typedef | Pointer to a PLC PHY Driver Transmission Confirm Event handler function |
| DRV_PLC_PHY_DATA_IND_CALLBACK | Typedef | Pointer to a PLC PHY Driver Reception Event handler function |
| DRV_PLC_PHY_SLEEP_CALLBACK | Typedef | Notifies when Sleep Mode is disabled and PLC PHY driver is available to be used again |
| DRV_PLC_PHY_EXCEPTION_CALLBACK | Typedef | Pointer to a PLC PHY Driver Exceptions Event handler function |
| DRV_PLC_PHY_EXCEPTION | Enum | Defines the type for PLC PHY Driver transfer errors |
G3 Data types and constants
| Name | Type | Description |
|---|---|---|
| DRV_PLC_PHY_ID | Enum | List of available G3 PLC PHY Information Base objects |
| DRV_PLC_PHY_MOD_TYPE | Enum | List of G3 modulations |
| DRV_PLC_PHY_MOD_SCHEME | Enum | List of G3 modulations schemes |
| DRV_PLC_PHY_DEL_TYPE | Enum | List of G3 delimiter types |
| DRV_PLC_PHY_TX_RESULT | Enum | List of transmission results |
| DRV_PLC_PHY_TONE_MAP_RSP | Struct | Includes modulation type, modulation scheme and Tone Map data |
| DRV_PLC_PHY_MAX_PSDU_LEN_PARAMS | Struct | Includes the parameters used to get the maximum PSDU length computation |
| DRV_PLC_PHY_TRANSMISSION_OBJ | Struct | Includes PLC Transmission setup data |
| DRV_PLC_PHY_TRANSMISSION_CFM_OBJ | Struct | Includes a transmission result and timestamp |
| DRV_PLC_PHY_RECEPTION_OBJ | Struct | Includes PLC PHY Reception data and PHY parameters |
| DRV_PLC_PHY_PIB_OBJ | Struct | Object to access the PLC PHY Information Base |
PRIME Data types and constants
| Name | Type | Description |
|---|---|---|
| DRV_PLC_PHY_ID | Enum | List of available PRIME PLC PHY Information Base objects |
| DRV_PLC_PHY_SCH | Enum | List of PRIME modulations schemes |
| DRV_PLC_PHY_FRAME_TYPE | Enum | List of PRIME frame types |
| DRV_PLC_PHY_HEADER | Enum | List of PRIME header types |
| DRV_PLC_PHY_CHANNEL | Enum | List of PRIME channels |
| DRV_PLC_PHY_BUFFER_ID | Enum | List of buffers ID to handle PLC communications |
| DRV_PLC_PHY_TX_RESULT | Enum | List of transmission results |
| DRV_PLC_PHY_SIGNAL_CAPTURE_STATE | Enum | Includes the Noise Capture States |
| DRV_PLC_PHY_SIGNAL_CAPTURE_INFO | Struct | Includes information about Noise Capture |
| DRV_PLC_PHY_TRANSMISSION_OBJ | Struct | Includes PLC Transmission setup data |
| DRV_PLC_PHY_TRANSMISSION_CFM_OBJ | Struct | Includes a transmission result and timestamp |
| DRV_PLC_PHY_RECEPTION_OBJ | Struct | Includes PLC PHY Reception data and PHY parameters |
| DRV_PLC_PHY_PIB_OBJ | Struct | Object to access the PLC PHY Information Base |