Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Static Public Member Functions
CordioHCITransportDriver Class Referenceabstract

Base class of the HCI transport driver. More...

#include <CordioHCITransportDriver.h>

Inheritance diagram for CordioHCITransportDriver:
AP3CordioHCITransportDriver H4TransportDriver NRFCordioHCITransportDriver IPCPipeTransportDriver CyH4TransportDriver

Public Member Functions

virtual ~CordioHCITransportDriver ()=default
 Driver destructor. More...
virtual void initialize ()=0
 Inialization of the transport. More...
virtual void terminate ()=0
 termination of the transport. More...
virtual uint16_t write (uint8_t type, uint16_t len, uint8_t *pData)=0
 Write data in the transport channel. More...

Static Public Member Functions

static void on_data_received (uint8_t *data, uint16_t len)
 The driver shall call this function whenever data bytes are received. More...

Detailed Description

Base class of the HCI transport driver.

It allow the stack to write data in the HCI channel.

Definition at line 29 of file CordioHCITransportDriver.h.

Constructor & Destructor Documentation

virtual ~CordioHCITransportDriver ( )

Driver destructor.

Member Function Documentation

virtual void initialize ( )
pure virtual
static void on_data_received ( uint8_t *  data,
uint16_t  len 

The driver shall call this function whenever data bytes are received.

dataPointer to the data received.
lenNumber of bytes received.
virtual void terminate ( )
pure virtual
virtual uint16_t write ( uint8_t  type,
uint16_t  len,
uint8_t *  pData 
pure virtual

Write data in the transport channel.

typeThe type of packet to transmit. It might be an HCI command packet, ACL packet or EVT packet. Depending on the type of transport it can prefix the packet itself.
lenNumber of bytes to transmit.
pDataPointer to the data to transmit. This is an WSF buffer and if CORDIO_ZERO_COPY_HCI is enabled we receive ownership.
The number of bytes which have been transmited.

Implemented in H4TransportDriver, CyH4TransportDriver, IPCPipeTransportDriver, NRFCordioHCITransportDriver, and AP3CordioHCITransportDriver.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.