Herzog Library 00.00.01  rel_libdev.herzog.00.00.01.10606
Data Structures | Macros | Typedefs | Functions
tx_device.h File Reference
#include <stdint.h>
#include "hdf.h"
#include "rf_codec.h"

Go to the source code of this file.

Data Structures

struct  TX_Config_t
 
struct  TX_Device_t
 A structure to represent TX device. More...
 

Macros

#define TX_BUFF_SIZE   128
 

Typedefs

typedef void(* tx_cb_func_t) (TX_Device_t *dev)
 

Functions

int32_t TX_devInit (TX_Device_t *dev, TX_Config_t *cfg)
 Initialize TX device. More...
 
TX_Device_tTX_devRequest (void)
 Request a TX device. More...
 
int32_t TX_devIsBusy (TX_Device_t *dev)
 Check if TX device busy. More...
 
int32_t TX_devSendData (TX_Device_t *dev, uint8_t *data, uint32_t len)
 Send data to TX device. More...
 
int32_t TX_devStop (TX_Device_t *dev)
 Stop transmission. More...
 
int32_t TX_devRegisterCallback (TX_Device_t *dev, void *cb)
 Register a call back function to TX device driver. More...
 
int32_t TX_devUnregisterCallback (TX_Device_t *dev)
 Un-Register a call back function to TX device driver. More...
 

Detailed Description

This file is proprietary to Indie Semiconductor. All rights reserved. Reproduction or distribution, in whole or in part, is forbidden except by express written permission of Indie Semiconductor.

Macro Definition Documentation

#define TX_BUFF_SIZE   128

Typedef Documentation

typedef void(* tx_cb_func_t) (TX_Device_t *dev)

Function Documentation

int32_t TX_devInit ( TX_Device_t dev,
TX_Config_t cfg 
)

Initialize TX device.

Parameters
devPointer to TX Device structure
cfgPointer to TX config data structure
Returns
0 for success or error code upon a failure
int32_t TX_devIsBusy ( TX_Device_t dev)

Check if TX device busy.

Parameters
devPointer to TX Device structure.
Returns
the number of bytes pending on TX or error code upon a failure
int32_t TX_devRegisterCallback ( TX_Device_t dev,
void *  cb 
)

Register a call back function to TX device driver.

Parameters
devPointer to TX Device structure
cbThe pointer to the call back function.
Returns
0 for success or error code upon a failure
TX_Device_t* TX_devRequest ( void  )

Request a TX device.

Returns
The pointer to the TX device or NULL upon a failure.
int32_t TX_devSendData ( TX_Device_t dev,
uint8_t *  data,
uint32_t  len 
)

Send data to TX device.

Parameters
devPointer to TX Device structure.
dataPointer to the data memory to be sent.
lenThe size of the data memory.
Returns
0 for success or error code upon a failure
int32_t TX_devStop ( TX_Device_t dev)

Stop transmission.

Parameters
devPointer to TX Device structure.
Returns
0 for success or error code upon a failure
int32_t TX_devUnregisterCallback ( TX_Device_t dev)

Un-Register a call back function to TX device driver.

Parameters
devPointer to TX Device structure
Returns
0 for success or error code upon a failure