Herzog Library 00.00.01  rel_libdev.herzog.00.00.01.10606
Data Structures | Typedefs | Functions
rx_device.h File Reference
#include "hdf.h"
#include "rf_codec.h"

Go to the source code of this file.

Data Structures

struct  RX_Dev_State_t
 A structure to represent RX device state. More...
 
struct  RX_Device_t
 A structure to represent RX device driver. More...
 

Typedefs

typedef const struct RX_Device_t RX_Device_Type
 
typedef void(* rx_cb_func_t) (RX_Device_Type *dev)
 
typedef const struct RX_Device_t RX_Device_t
 A structure to represent RX device driver. More...
 

Functions

RX_Device_tRX_devRequest (void)
 Request a RX device. More...
 
int32_t RX_devInit (RX_Device_t *dev, uint8_t bytes, DCM_FMT_t fmt)
 Initialize RX device. More...
 
int32_t RX_devGetReceivedData (RX_Device_t *dev, uint8_t *data, uint32_t len)
 Send data to RX device. More...
 
int32_t RX_devStop (RX_Device_t *dev)
 Stop Receiver. More...
 
int32_t RX_devRegisterCallback (RX_Device_t *dev, void *cb)
 Register a call back function to RX device driver. More...
 
int32_t RX_devUnregisterCallback (RX_Device_t *dev)
 Un-Register a call back function to RX 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.

Typedef Documentation

typedef void(* rx_cb_func_t) (RX_Device_Type *dev)
typedef const struct RX_Device_t RX_Device_t

A structure to represent RX device driver.

typedef const struct RX_Device_t RX_Device_Type

Function Documentation

int32_t RX_devGetReceivedData ( RX_Device_t dev,
uint8_t *  data,
uint32_t  len 
)

Send data to RX device.

Parameters
devPointer to RX Device structure.
dataPointer to the data memory to save the received data.
lenThe size of the data memory.
Returns
0 for success or error code upon a failure
int32_t RX_devInit ( RX_Device_t dev,
uint8_t  bytes,
DCM_FMT_t  fmt 
)

Initialize RX device.

Parameters
devPointer to RX Device structure
bytesThe number of bytes expect to receive, the message length.
fmtThe enum for the duty-cycle modulation format.
Returns
0 for success or error code upon a failure
int32_t RX_devRegisterCallback ( RX_Device_t dev,
void *  cb 
)

Register a call back function to RX device driver.

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

Request a RX device.

Returns
The pointer to the RX device or NULL upon a failure.
int32_t RX_devStop ( RX_Device_t dev)

Stop Receiver.

Parameters
devPointer to RX Device structure.
Returns
0 for success or error code upon a failure
int32_t RX_devUnregisterCallback ( RX_Device_t dev)

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

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