CordioHCITransportDriver Class Reference

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

#include <CordioHCITransportDriver.h>

Inheritance diagram for CordioHCITransportDriver:

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

~CordioHCITransportDriver()

virtual ~CordioHCITransportDriver ( )

virtualdefault

Driver destructor.

Member Function Documentation

initialize()

virtual void initialize ( )

pure virtual

Inialization of the transport.

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

terminate()

virtual void terminate ( )

pure virtual

termination of the transport.

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

write()

virtual uint16_t write ( uint8_t  type, uint16_t  len, uint8_t *  pData  )

pure virtual

Write data in the transport channel.

Parameters

type	The 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.
len	Number of bytes to transmit.
pData	Pointer to the data to transmit. This is an WSF buffer and if CORDIO_ZERO_COPY_HCI is enabled we receive ownership.

Returns

The number of bytes which have been transmited.

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

on_data_received()

static void on_data_received ( uint8_t *  data, uint16_t  len  )

static

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

Parameters

data	Pointer to the data received.
len	Number of bytes received.