5 Data Structure Documentation

Detailed information on the data structures used in the LIN Responder Library firmware

The frames and signals data structures depend on the Melody UI configuration. Refer to Figure 7-1 in LIN Responder Use Case Examples for the frames and signals used in this section.

5.1 frame1_t Union Reference

Type definition of the Frame1 frame and signal data.

5.1.2 Field Documentation

The documentation for this union was generated from the following file:

source/

lin_config.h

5.1.2.1 @1

struct { ... }

5.1.2.2 __pad0__

unsigned __pad0__

5.1.2.3 data

l_u8 data[FRAME1_BYTES]

5.1.2.4 Frame1_ArraySignal

l_u8 Frame1_ArraySignal[3]

5.1.2.5 Frame1_BoolSignal

unsigned Frame1_BoolSignal

5.1.2.6 Frame1_Scalar16SignalL

unsigned Frame1_Scalar16SignalL

5.1.2.7 Frame1_Scalar16SignalH

unsigned Frame1_Scalar16SignalH

5.1.2.8 Frame1_Scalar4Signal

unsigned Frame1_Scalar4Signal

5.2 frame2_t Union Reference

Type definition of the Frame2 frame and signal data.

5.2.2 Field Documentation

The documentation for this union was generated from the following file:

source/

lin_config.h

5.2.2.1 @3

struct { ... }

5.2.2.2 __pad0__

unsigned __pad0__

5.2.2.3 data

l_u8 data[FRAME2_BYTES]

5.2.2.4 Frame2_ArraySignal

l_u8 Frame2_ArraySignal[3]

5.2.2.5 Frame2_BoolSignal

unsigned Frame2_BoolSignal

5.2.2.6 Frame2_Scalar16SignalL

unsigned Frame2_Scalar16SignalL

5.2.2.7 Frame2_Scalar16SignalH

unsigned Frame2_Scalar16SignalH

5.2.2.8 Frame2_Scalar4Signal

unsigned Frame2_Scalar4Signal

5.3 frame3_t Union Reference

Type definition of the Frame3 frame and signal data.

5.3.2 Field Documentation

The documentation for this union was generated from the following file:

source/

lin_config.h

5.3.2.1 @5

struct { ... }

5.3.2.2 __pad0__

unsigned __pad0__

5.3.2.3 __pad1__

unsigned __pad1__

5.3.2.4 data

l_u8 data[FRAME3_BYTES]

5.3.2.5 Frame3_ErrorSignal

unsigned Frame3_ErrorSignal

5.4 lin_packet_t Struct Reference

Structure for a LIN packet.

5.4.2 Field Documentation

The documentation for this struct was generated from the following file:

source/

lin_responder.h

5.4.2.1 checksum

uint8_t checksum

5.4.2.2 data

uint8_t data[MAX_DATA_LENGTH]

5.4.2.3 length

uint8_t length

5.4.2.4 pid

uint8_t pid

5.4.2.5 timeout

uint8_t timeout

5.4.2.6 type

lin_packet_type_t type

5.5 lin_pid_t Struct Reference

Structure for the LIN Protected Identifier (PID).

5.5.1 Detailed Description

Structure for the LIN Protected Identifier (PID).

#include <lin_responder.h>

5.5.1.1 Data Fields

5.5.2 Field Documentation

The documentation for this struct was generated from the following file:

source/

lin_responder.h

5.5.2.1 id0

uint8_t id0

5.5.2.2 id1

uint8_t id1

5.5.2.3 id2

uint8_t id2

5.5.2.4 id3

uint8_t id3

5.5.2.5 id4

uint8_t id4

5.5.2.6 id5

uint8_t id5

5.5.2.7 p0

uint8_t p0

5.5.2.8 p1

uint8_t p1

5.6 lin_rx_cmd_t Struct Reference

Structure for a received LIN command.

5.6.2 Field Documentation

The documentation for this struct was generated from the following file:

source/

lin_responder.h

5.6.2.1 cmd

uint8_t cmd

5.6.2.2 data

uint8_t* data

5.6.2.3 length

uint8_t length

5.6.2.4 timeout

uint8_t timeout

5.6.2.5 type

lin_packet_type_t type

5.7 LIN_TIMER Struct Reference

Declaration of a structure of function pointers for the LIN Responder’s Timer functions.

5.7.1 Detailed Description

Declaration of a structure of function pointers for the LIN Responder’s Timer functions.

#include <lin_hal.h>

The documentation for this struct was generated from the following file:

source/

lin_hal.h

5.8 LIN_TIMER_INTERFACE Struct Reference

Structure of function pointers for the LIN Responder’s Timer functions.

5.8.2 Field Documentation

The documentation for this struct was generated from the following file:

source/

lin_timer_interface.h

5.8.2.1 IsTimerRunning

bool(* IsTimerRunning) (void)

5.8.2.2 TimeoutCallbackRegister

void(* TimeoutCallbackRegister) (void(*callback)(void))

5.8.2.3 TimerDeinitialize

void(* TimerDeinitialize) (void)

5.8.2.4 TimerInitialize

void(* TimerInitialize) (void)

5.8.2.5 TimerStart

void(* TimerStart) (uint8_t timeout)

5.8.2.6 TimerStop

void(* TimerStop) (void)

5.9 LIN_UART Struct Reference

Declaration of a structure of function pointers for the LIN Responder’s UART functions.

5.9.1 Detailed Description

Declaration of a structure of function pointers for the LIN Responder’s UART functions.

#include <lin_hal.h>

The documentation for this struct was generated from the following file:

source/

lin_hal.h

5.10 LIN_UART_INTERFACE Struct Reference

Structure of function pointers for the LIN Responder’s UART functions.

5.10.1 Detailed Description

Structure of function pointers for the LIN Responder’s UART functions.

#include <lin_uart_interface.h>

5.10.1.1 Data Fields

5.10.2 Field Documentation

The documentation for this struct was generated from the following file:

source/

lin_uart_interface.h

5.10.2.1 FramingErrorCallbackRegister

void(* FramingErrorCallbackRegister) (void(*CallbackHandler)(void))

5.10.2.2 IsBreakReceived

bool(* IsBreakReceived) (void)

5.10.2.3 IsFramingError

bool(* IsFramingError) (void)

5.10.2.4 IsRxReady

bool(* IsRxReady) (void)

5.10.2.5 IsSyncValid

bool(* IsSyncValid) (void)

5.10.2.6 Read

uint8_t(* Read) (void)

5.10.2.7 RxCompleteCallbackRegister

void(* RxCompleteCallbackRegister) (void(*CallbackHandler)(void))

5.10.2.8 RxDeinitialize

void(* RxDeinitialize) (void)

5.10.2.9 RxInitialize

void(* RxInitialize) (void)

5.10.2.10 TxCompleteCallbackRegister

void(* TxCompleteCallbackRegister) (void(*CallbackHandler)(void))

5.10.2.11 TxInterruptDisable

void(* TxInterruptDisable) (void)

5.10.2.12 TxInterruptEnable

void(* TxInterruptEnable) (void)

5.10.2.13 Write

void(* Write) (uint8_t txData)