lin  2.0.0.0
Functions
Public function

Functions

void lin_cfg_setup (lin_cfg_t *cfg)
 Config Object Initialization function. More...
 
LIN_RETVAL lin_init (lin_t *ctx, lin_cfg_t *cfg)
 Initialization function. More...
 
void lin_generic_multi_write (lin_t *ctx, lin_data_t *data_buf, uart_length_t len)
 Generic multi write function. More...
 
void lin_generic_multi_read (lin_t *ctx, lin_data_t *data_buf, uart_length_t len)
 Generic multi read function. More...
 
lin_data_t lin_generic_single_read (lin_t *ctx)
 Generic single read function. More...
 
void lin_generic_single_write (lin_t *ctx, lin_data_t tx_data)
 Generic single write function. More...
 
uint8_t lin_enable_pin_set (lin_t *ctx, uint8_t state)
 Sets state of pin. More...
 
uint8_t lin_inhibit_pin_set (lin_t *ctx, uint8_t state)
 Sets state of pin. More...
 
uint8_t lin_wake_pin_set (lin_t *ctx, uint8_t state)
 Sets state of pin. More...
 

Detailed Description

Function Documentation

◆ lin_cfg_setup()

void lin_cfg_setup ( lin_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ lin_enable_pin_set()

uint8_t lin_enable_pin_set ( lin_t ctx,
uint8_t  state 
)

Sets state of pin.

Parameters
ctxClick object.
stateCan be LIN_PIN_STATE_LOW or LIN_PIN_STATE_HIGH
Returns
Can be LIN_FUNCTION_ERROR or LIN_OK

@description This function sets state of the pin to high or low depending on state value and returns info.

◆ lin_generic_multi_read()

void lin_generic_multi_read ( lin_t ctx,
lin_data_t data_buf,
uart_length_t  len 
)

Generic multi read function.

Parameters
ctxClick object.
data_bufOutput data buffer.
lenNumber of the bytes in data buffer.

@description This function reads data.

◆ lin_generic_multi_write()

void lin_generic_multi_write ( lin_t ctx,
lin_data_t data_buf,
uart_length_t  len 
)

Generic multi write function.

Parameters
ctxClick object.
data_bufInput data buffer
lenNumber of the bytes in the data buffer

@description This function writes data.

◆ lin_generic_single_read()

lin_data_t lin_generic_single_read ( lin_t ctx)

Generic single read function.

Parameters
ctxClick object.
Returns
one byte data

@description This function read one byte data.

◆ lin_generic_single_write()

void lin_generic_single_write ( lin_t ctx,
lin_data_t  tx_data 
)

Generic single write function.

Parameters
ctxClick object.
tx_dataInput data

@description This function write one byte data.

◆ lin_inhibit_pin_set()

uint8_t lin_inhibit_pin_set ( lin_t ctx,
uint8_t  state 
)

Sets state of pin.

Parameters
ctxClick object.
stateCan be LIN_PIN_STATE_LOW or LIN_PIN_STATE_HIGH
Returns
Can be LIN_FUNCTION_ERROR or LIN_OK

@description This function sets state of the pin to high or low depending on state value and returns info.

◆ lin_init()

LIN_RETVAL lin_init ( lin_t ctx,
lin_cfg_t cfg 
)

Initialization function.

Parameters
linClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ lin_wake_pin_set()

uint8_t lin_wake_pin_set ( lin_t ctx,
uint8_t  state 
)

Sets state of pin.

Parameters
ctxClick object.
stateCan be LIN_PIN_STATE_LOW or LIN_PIN_STATE_HIGH
Returns
Can be LIN_FUNCTION_ERROR or LIN_OK

@description This function sets state of the pin to high or low depending on state value and returns info.