Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
 4.0.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
hdlc_api Struct Reference

HDLC interface configuration data. More...

#include <hdlc_rcp_if.h>

Data Fields

struct net_if_api iface_api
 HDLC interface API.
 
int(* register_rx_cb )(hdlc_rx_callback_t hdlc_rx_callback, void *param)
 Register the Spinel HDLC RX callback.
 
int(* send )(const uint8_t *frame, uint16_t length)
 Transmit a HDLC frame.
 
int(* deinit )(void)
 Deinitialize the device.
 

Detailed Description

HDLC interface configuration data.

Field Documentation

◆ deinit

int(* hdlc_api::deinit) (void)

Deinitialize the device.

Parameters
none
Return values
0The interface was successfully stopped.
-EIOThe interface could not be stopped.

◆ iface_api

struct net_if_api hdlc_api::iface_api

HDLC interface API.

◆ register_rx_cb

int(* hdlc_api::register_rx_cb) (hdlc_rx_callback_t hdlc_rx_callback, void *param)

Register the Spinel HDLC RX callback.

Parameters
hdlc_rx_callbackpointer to the spinel HDLC RX callback
parampointer to the spinel HDLC interface
Return values
0The callback was successfully registered.
-EIOThe callback could not be registered.

◆ send

int(* hdlc_api::send) (const uint8_t *frame, uint16_t length)

Transmit a HDLC frame.

Parameters
framepointer to the HDLC frame to be transmitted.
lengthlength of the HDLC frame to be transmitted.
Return values
0The frame was successfully sent.
-EIOThe frame could not be sent due to some unspecified interface error (e.g. the interface being busy).

The documentation for this struct was generated from the following file: