4 Module Documentation

• #define l_sys_init LINRESP_Initialize

• l_bool l_bool_rd_Frame1_BoolSignal (void)

  Reads and returns the current value of the Frame1_BoolSignal.

• void l_bool_wr_Frame1_BoolSignal (l_bool v)

  Sets the current value of Frame1_BoolSignal.

• l_u8 l_u8_rd_Frame1_Scalar4Signal (void)

  Reads and returns the current value of Frame1_Scalar4Signal.

• void l_u8_wr_Frame1_Scalar4Signal (l_u8 v)

  Sets the current value of Frame1_Scalar4Signal.

• l_u16 l_u16_rd_Frame1_Scalar16Signal (void)

  Reads and returns the current value of Frame1_Scalar16Signal.

• void l_u16_wr_Frame1_Scalar16Signal (l_u16 v)

  Sets the current value of Frame1_Scalar16Signal.

• void l_bytes_rd_Frame1_ArraySignal (l_u8 start, l_u8 count, l_u8 *const data)

  Reads and returns the current values of the selected bytes in Frame1_ArraySignal.

• void l_bytes_wr_Frame1_ArraySignal (l_u8 start, l_u8 count, const l_u8 *const data)

  Sets the current value of the selected bytes in Frame1_ArraySignal.

• l_bool l_bool_rd_Frame2_BoolSignal (void)

  Reads and returns the current value of Frame2_BoolSignal.

• void l_bool_wr_Frame2_BoolSignal (l_bool v)

  Sets the current value of Frame2_BoolSignal.

• l_u8 l_u8_rd_Frame2_Scalar4Signal (void)

  Reads and returns the current value of Frame2_Scalar4Signal.

• void l_u8_wr_Frame2_Scalar4Signal (l_u8 v)

  Sets the current value of Frame2_Scalar4Signal.

• l_u16 l_u16_rd_Frame2_Scalar16Signal (void)

  Reads and returns the current value of Frame2_Scalar16Signal.

• void l_u16_wr_Frame2_Scalar16Signal (l_u16 v)

  Sets the current value of Frame2_Scalar16Signal.

• void l_bytes_rd_Frame2_ArraySignal (l_u8 start, l_u8 count, l_u8 *const data)

  Reads and returns the current values of the selected bytes in Frame2_ArraySignal.

• void l_bytes_wr_Frame2_ArraySignal (l_u8 start, l_u8 count, const l_u8 *const data)

  Sets the current value of the selected bytes in Frame2_ArraySignal.

• l_bool l_bool_rd_Frame3_ErrorSignal (void)

  Reads and returns the current value of Frame3_ErrorSignal.

• void l_bool_wr_Frame3_ErrorSignal (l_bool v)

  Sets the current value of Frame3_ErrorSignal.

• #define FRAME1_BOOLSIGNAL_INIT (0U)

• #define FRAME1_SCALAR4SIGNAL_INIT (0U)

• #define FRAME1_SCALAR16SIGNAL_INIT (0U)

• #define FRAME1_ARRAYSIGNAL_INIT {1,2,3}

• #define FRAME2_BOOLSIGNAL_INIT (0U)

• #define FRAME2_SCALAR4SIGNAL_INIT (0U)

• #define FRAME2_SCALAR16SIGNAL_INIT (0U)

• #define FRAME2_ARRAYSIGNAL_INIT {1,2,3}

• #define FRAME3_ERRORSIGNAL_INIT (0U)

#define FRAME1_ARRAYSIGNAL_INIT {1,2,3}

#define FRAME1_BOOLSIGNAL_INIT (0U)

#define FRAME1_SCALAR16SIGNAL_INIT (0U)

#define FRAME1_SCALAR4SIGNAL_INIT (0U)

#define FRAME2_ARRAYSIGNAL_INIT {1,2,3}

#define FRAME2_BOOLSIGNAL_INIT (0U)

#define FRAME2_SCALAR16SIGNAL_INIT (0U)

#define FRAME2_SCALAR4SIGNAL_INIT (0U)

#define FRAME3_ERRORSIGNAL_INIT (0U)

#define l_sys_init LINRESP_Initialize

Function macro for initializing the LIN system.

l_bool l_bool_rd_Frame1_BoolSignal (void )

Reads and returns the current value of Frame1_BoolSignal.

l_bool l_bool_rd_Frame2_BoolSignal (void )

Reads and returns the current value of Frame2_BoolSignal.

l_bool l_bool_rd_Frame3_ErrorSignal (void )

Reads and returns the current value of Frame3_ErrorSignal.

void l_bool_wr_Frame1_BoolSignal (l_bool v)

Sets the current value of Frame1_BoolSignal.

void l_bool_wr_Frame2_BoolSignal (l_bool v)

Sets the current value of Frame2_BoolSignal.

void l_bool_wr_Frame3_ErrorSignal (l_bool v)

Sets the current value of Frame3_ErrorSignal.

void l_bytes_rd_Frame1_ArraySignal (l_u8 start, l_u8 count, l_u8 *const data)

Reads and returns the current values of the selected bytes in Frame1_ArraySignal.

void l_bytes_rd_Frame2_ArraySignal (l_u8 start, l_u8 count, l_u8 *const data)

Reads and returns the current values of the selected bytes in Frame2_ArraySignal.

void l_bytes_wr_Frame1_ArraySignal (l_u8 start, l_u8 count, const l_u8 *const data)

Sets the current value of the selected bytes in Frame1_ArraySignal.

void l_bytes_wr_Frame2_ArraySignal (l_u8 start, l_u8 count, const l_u8 *const data)

Sets the current value of the selected bytes in Frame2_ArraySignal.

l_u16 l_u16_rd_Frame1_Scalar16Signal (void )

Reads and returns the current value of Frame1_Scalar16Signal.

l_u16 l_u16_rd_Frame2_Scalar16Signal (void )

Reads and returns the current value of Frame2_Scalar16Signal.

void l_u16_wr_Frame1_Scalar16Signal (l_u16 v)

Sets the current value of Frame1_Scalar16Signal.

void l_u16_wr_Frame2_Scalar16Signal (l_u16 v)

Sets the current value of Frame2_Scalar16Signal.

l_u8 l_u8_rd_Frame1_Scalar4Signal (void )

Reads and returns the current value of Frame1_Scalar4Signal.

l_u8 l_u8_rd_Frame2_Scalar4Signal (void )

Reads and returns the current value of Frame2_Scalar4Signal.

void l_u8_wr_Frame1_Scalar4Signal (l_u8 v)

Sets the current value of Frame1_Scalar4Signal.

void l_u8_wr_Frame2_Scalar4Signal (l_u8 v)

Sets the current value of Frame2_Scalar4Signal.

• union frame1_t

  Type definition of the Frame1 frame and signal data.

• union frame2_t

  Type definition of the Frame2 frame and signal data.

• union frame3_t

  Type definition of the Frame3 frame and signal data.

• #define SCHED_TABLE_LENGTH (3U)

  Defines the total number of frames in the schedule table.

• enum lin_cmd_t { FRAME1 = 0x00, FRAME2 = 0x01, FRAME3 = 0x02 }

  Enumeration for the frames and their command identifiers.

• bool LINRESP_Initialize (void)

  Sets up the necessary configurations and initializes the LIN Responder module.

• void LINRESP_Deinitialize (void)

  Deinitializes the LIN Responder module.

• void LINRESP_DataProcess (void)

  Processes the received or transmitted data.

• void FRAME1_AppCallbackRegister (void(*callback)(void))

  Registers a callback function for a Frame1 receive/transmit event.

• void FRAME2_AppCallbackRegister (void(*callback)(void))

  Registers a callback function for a Frame2 receive/transmit event.

• void FRAME3_AppCallbackRegister (void(*callback)(void))

  Registers a callback function for a Frame3 receive/transmit event.

• static void LINRESP_RespErrorSet (void)

  Sets the node's response_error signal.

• static void LINRESP_RespErrorClr (void)

  Clears the node's response_error signal.

• lin_rx_cmd_t schedTable [SCHED_TABLE_LENGTH]

  Declaration of the schedule table.

• l_u8 schedTableSize

  Declaration of the number of frames in a schedule table.

• frame1_t Frame1

  Declaration of the Frame1 data.

• frame2_t Frame2

  Declaration of the Frame2 data.

• frame3_t Frame3

  Declaration of the Frame3 data.

• #define FRAME1_BYTES (6U)

• #define FRAME2_BYTES (6U)

• #define FRAME3_BYTES (1U)

• #define FRAME1_TIMEOUT_MS (10U)

• #define FRAME2_TIMEOUT_MS (10U)

• #define FRAME3_TIMEOUT_MS (3U)

• typedef bool l_bool

• typedef uint8_t l_u8

• typedef uint16_t l_u16

• #define FRAME1_BOOLSIGNAL_BITS (1U)

• #define FRAME1_SCALAR4SIGNAL_BITS (4U)

• #define FRAME1_SCALAR16SIGNALH_BITS (8U)

• #define FRAME1_SCALAR16SIGNALL_BITS (8U)

• #define FRAME1_ARRAYSIGNAL_BYTES (3U)

• #define FRAME2_BOOLSIGNAL_BITS (1U)

• #define FRAME2_SCALAR4SIGNAL_BITS (4U)

• #define FRAME2_SCALAR16SIGNALH_BITS (8U)

• #define FRAME2_SCALAR16SIGNALL_BITS (8U)

• #define FRAME2_ARRAYSIGNAL_BYTES (3U)

• #define FRAME3_ERRORSIGNAL_BITS (1U)

• #define FRAME1_BOOLSIGNAL_BITMASK (0x01U)

• #define FRAME1_SCALAR4SIGNAL_BITMASK (0x0FU)

• #define FRAME1_SCALAR16SIGNALH_BITMASK (0xFFU)

• #define FRAME1_SCALAR16SIGNALL_BITMASK (0xFFU)

• #define FRAME2_BOOLSIGNAL_BITMASK (0x01U)

• #define FRAME2_SCALAR4SIGNAL_BITMASK (0x0FU)

• #define FRAME2_SCALAR16SIGNALH_BITMASK (0xFFU)

• #define FRAME2_SCALAR16SIGNALL_BITMASK (0xFFU)

• #define FRAME3_ERRORSIGNAL_BITMASK (0x01U)

#define FRAME1_ARRAYSIGNAL_BYTES (3U)

#define FRAME1_BOOLSIGNAL_BITMASK (0x01U)

#define FRAME1_BOOLSIGNAL_BITS (1U)

#define FRAME1_BYTES (6U)

#define FRAME1_SCALAR16SIGNALH_BITMASK (0xFFU)

#define FRAME1_SCALAR16SIGNALH_BITS (8U)

#define FRAME1_SCALAR16SIGNALL_BITMASK (0xFFU)

#define FRAME1_SCALAR16SIGNALL_BITS (8U)

#define FRAME1_SCALAR4SIGNAL_BITMASK (0x0FU)

#define FRAME1_SCALAR4SIGNAL_BITS (4U)

#define FRAME1_TIMEOUT_MS (10U)

#define FRAME2_ARRAYSIGNAL_BYTES (3U)

#define FRAME2_BOOLSIGNAL_BITMASK (0x01U)

#define FRAME2_BOOLSIGNAL_BITS (1U)

#define FRAME2_BYTES (6U)

#define FRAME2_SCALAR16SIGNALH_BITMASK (0xFFU)

#define FRAME2_SCALAR16SIGNALH_BITS (8U)

#define FRAME2_SCALAR16SIGNALL_BITMASK (0xFFU)

#define FRAME2_SCALAR16SIGNALL_BITS (8U)

#define FRAME2_SCALAR4SIGNAL_BITMASK (0x0FU)

#define FRAME2_SCALAR4SIGNAL_BITS (4U)

#define FRAME2_TIMEOUT_MS (10U)

#define FRAME3_BYTES (1U)

#define FRAME3_ERRORSIGNAL_BITMASK (0x01U)

#define FRAME3_ERRORSIGNAL_BITS (1U)

#define FRAME3_TIMEOUT_MS (3U)

#define SCHED_TABLE_LENGTH (3U)

Defines the total number of frames in the schedule table.

typedef bool l_bool

typedef uint16_t l_u16

typedef uint8_t l_u8

void FRAME1_AppCallbackRegister (void (*callback) void)

Registers a callback function for a Frame1 receive/transmit event.

void FRAME2_AppCallbackRegister (void (*callback) void)

Registers a callback function for a Frame2 receive/transmit event.

void FRAME3_AppCallbackRegister (void (*callback) void)

Registers a callback function for a Frame3 receive/transmit event.

void LINRESP_DataProcess (void )

Processes the received or transmitted data.

void LINRESP_Deinitialize (void )

Deinitializes the LIN Responder module.

bool LINRESP_Initialize (void )

Sets up the necessary configurations and initializes the LIN Responder module.

Section: Global Function Definitions

void LINRESP_RespErrorClr (void )[static]

Clears the node's response_error signal.

void LINRESP_RespErrorSet (void )[static]

Sets the node's response_error signal.

Section: Local Function Declarations

Section: Local Function Definitions

enum lin_cmd_t

Enumeration for the frames and their command identifiers.

frame1_t Frame1

Declaration of the Frame1 data.

frame2_t Frame2

Declaration of the Frame2 data.

frame3_t Frame3

Declaration of the Frame3 data.

lin_rx_cmd_t schedTable[SCHED_TABLE_LENGTH]

Declaration of the schedule table.

l_u8 schedTableSize

Declaration of the number of frames in a schedule table.

• struct LIN_UART

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

• struct LIN_TIMER

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

• struct lin_rx_cmd_t

  Structure for a received LIN command.

• struct lin_packet_t

  Structure for a LIN packet.

• struct lin_pid_t

  Structure for the LIN Protected Identifier (PID).

• #define MAX_DATA_LENGTH (8U)

  Defines the maximum data length in bytes.

• #define CLEAR_PARITY_BITS (0x3FU)

  Defines the mask value to clear the PID parity bits.

• enum lin_checksum_t { CLASSIC, ENHANCED }

  Enumeration for the LIN checksum types.

• enum lin_packet_type_t { LIN_ERROR, LIN_TRANSMIT, LIN_RECEIVE }

  Enumeration for the LIN packet types.

• enum lin_rx_state_t { LIN_RX_IDLE, LIN_RX_ACTIVE, LIN_RX_BRK, LIN_RX_SYNC, LIN_RX_PID, LIN_RX_DATA, LIN_RX_CHECKSUM, LIN_TX_RX_DATA, LIN_TX_RX_CHECKSUM, LIN_RX_READY, LIN_RX_ERROR, LIN_RX_RESET }

  Enumeration for the LIN Responder states.

• enum lin_rx_status_t { LIN_BRK_ERROR, LIN_SYNC_ERROR, LIN_PID_ERROR, LIN_CHECKSUM_ERROR, LIN_READBACK_ERROR, LIN_FRAMING_ERROR, LIN_RESP_TOOSHORT, LIN_NO_RESPONSE, LIN_NO_ERROR }

  Enumeration for the LIN Responder status.

• enum lin_sched_param_t { CMD, TYPE, LENGTH, TIMEOUT }

  Enumeration for the scheduling table parameters.

• void LINRESP_ConfigInit (uint8_t tableSize, lin_rx_cmd_t *command, void(*dataProcess)(void))

  Initializes the LIN Responder configuration.

• void LINRESP_ConfigDeinit (void)

  Deinitializes the LIN Responder configuration.

• lin_rx_state_t LINRESP_Handler (void)

  Handles the LIN Responder state machine.

• uint8_t LINRESP_IdGet (void)

  Gets the ID of the active packet.

• bool LINRESP_IsIdle (void)

  Checks if the frame processor is in idle state.

• void LINRESP_BrkErrCallbackRegister (void(*callback)(void))

  Registers a callback function for Break error condition.

• void LINRESP_SyncErrCallbackRegister (void(*callback)(void))

  Registers a callback function for the Sync error condition.

• void LINRESP_PidErrCallbackRegister (void(*callback)(void))

  Registers a callback function for the PID error condition.

• void LINRESP_ChecksumErrCallbackRegister (void(*callback)(void))

  Registers a callback function for the Checksum error condition.

• void LINRESP_ReadbackErrCallbackRegister (void(*callback)(void))

  Registers a callback function for readback error condition.

• void LINRESP_FramingErrCallbackRegister (void(*callback)(void))

  Registers a callback function for framing error condition.

• void LINRESP_ShortRespErrCallbackRegister (void(*callback)(void))

  Registers a callback function for frame response too short error condition.

• void LINRESP_NoRespErrCallbackRegister (void(*callback)(void))

  Registers a callback function for no response received error condition.

• void LINRESP_ErrorSetCallbackRegister (void(*callback)(void))

  Registers a callback function for an error set condition.

#define CLEAR_PARITY_BITS (0x3FU)

Defines the mask value to clear the PID parity bits.

#define MAX_DATA_LENGTH (8U)

Defines the maximum data length in bytes.

void LINRESP_BrkErrCallbackRegister (void (*callback) void)

Registers a callback function for Break error condition.

void LINRESP_ChecksumErrCallbackRegister (void (*callback) void)

Registers a callback function for the Checksum error condition.

void LINRESP_ConfigDeinit (void )

Deinitializes the LIN Responder configuration.

void LINRESP_ConfigInit (uint8_t tableSize, lin_rx_cmd_t * command, void(*dataProcess)(void)

Initializes the LIN Responder configuration.

Section: Global Function Definitions

void LINRESP_ErrorSetCallbackRegister (void (*callback) void)

Registers a callback function for an error set condition.

void LINRESP_FramingErrCallbackRegister (void (*callback) void)

Registers a callback function for framing error condition.

lin_rx_state_t LINRESP_Handler (void )

Handles the LIN Responder state machine.

uint8_t LINRESP_IdGet (void )

Gets the ID of the active packet.

bool LINRESP_IsIdle (void )

Checks if the frame processor is in idle state.

void LINRESP_NoRespErrCallbackRegister (void (*callback) void)

Registers a callback function for no response received error condition.

void LINRESP_PidErrCallbackRegister (void (*callback) void)

Registers a callback function for the PID error condition.

void LINRESP_ReadbackErrCallbackRegister (void (*callback) void)

Registers a callback function for readback error condition.

void LINRESP_ShortRespErrCallbackRegister (void (*callback) void)

Registers a callback function for frame response too short error condition.

void LINRESP_SyncErrCallbackRegister (void (*callback) void)

Registers a callback function for the Sync error condition.

enum lin_checksum_t

Enumeration for the LIN checksum types.

enum lin_packet_type_t

Enumeration for the LIN packet types.

enum lin_rx_state_t

Enumeration for the LIN Responder states.

enum lin_rx_status_t

Enumeration for the LIN Responder status.

enum lin_sched_param_t

Enumeration for the scheduling table parameters.

• struct LIN_TIMER_INTERFACE

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

• void LINRESP_TimerInitialize (void)

  Initializes the timer.

• void LINRESP_TimerDeinitialize (void)

  Deinitializes the timer.

• void LINRESP_TimerStart (uint8_t timeout)

  Starts the LIN timer with a specified time-out value.

• void LINRESP_TimerStop (void)

  Stops the LIN timer.

• bool LINRESP_IsTimerRunning (void)

  Checks if the LIN timer is currently running.

• void LINRESP_TimeoutCallbackRegister (void(*callback)(void))

  Registers a callback function for a LIN timeout.

• void LINRESP_TimerCallback (void)

  Executes on every LIN timer interrupt event.

bool LINRESP_IsTimerRunning (void )

Checks if the LIN timer is currently running.

void LINRESP_TimeoutCallbackRegister (void(*)(void) callback)

Registers a callback function for a LIN timeout.

void LINRESP_TimerCallback (void )

Executes on every LIN timer interrupt event.

Section: Local Function Declarations

Section: Local Function Definitions

void LINRESP_TimerDeinitialize (void )

Deinitializes the timer.

void LINRESP_TimerInitialize (void )

Initializes the timer.

Section: Global Function Definitions

void LINRESP_TimerStart (uint8_t timeout)

Starts the LIN timer with a specified time-out value.

void LINRESP_TimerStop (void )

Stops the LIN timer.

• struct LIN_UART_INTERFACE

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

• uint8_t LINRESP_Read (void)

  Reads a data byte from the UART receive buffer.

• bool LINRESP_IsRxReady (void)

  Checks if there is available data in the UART receive buffer.

• void LINRESP_Write (uint8_t txData)

  Writes a byte of data to the UART transmit buffer.

• void LINRESP_RxInitialize (void)

  Initializes LIN receive operation.

• void LINRESP_RxDeinitialize (void)

  Deinitializes the UART receiver.

• void LINRESP_TxInterruptEnable (void)

  Enables the UART transmit interrupt.

• void LINRESP_TxInterruptDisable (void)

  Disables the UART transmit interrupt.

• bool LINRESP_IsFramingError (void)

  Checks if there is a framing error.

• bool LINRESP_IsBreakReceived (void)

  Checks if a LIN Break character has been received.

• bool LINRESP_IsSyncValid (void)

  Checks if the Sync character is valid.

• void LINRESP_FramingErrorCallbackRegister (void(*callback)(void))

  Registers a callback function for framing error detection.

• void LINRESP_RxCompleteCallbackRegister (void(*callback)(void))

  Registers a callback function for byte receive completion.

• void LINRESP_TxCompleteCallbackRegister (void(*callback)(void))

  Registers a callback function for byte transmit completion.

• static void LINRESP_ReceiveISR (void)

  Custom interrupt service routine for UART byte reception.

• static void LINRESP_AutobaudEnable (void)

  Checks and enables the autobaud detection mechanism if autobaud is enabled.

• static void LINRESP_AutobaudReset (void)

  Resets the autobaud detection mechanism.

void LINRESP_AutobaudEnable (void )[static]

Checks and enables the autobaud detection mechanism if autobaud is enabled.

void LINRESP_AutobaudReset (void )[static]

Resets the autobaud detection mechanism.

void LINRESP_FramingErrorCallbackRegister (void (*callback) void)

Registers a callback function for framing error detection.

bool LINRESP_IsBreakReceived (void )

Checks if a LIN Break character has been received.

bool LINRESP_IsFramingError (void )

Checks if there is a framing error.

bool LINRESP_IsRxReady (void )

Checks if there is available data in the UART receive buffer.

bool LINRESP_IsSyncValid (void )

Checks if the Sync character is valid.

uint8_t LINRESP_Read (void )

Reads a data byte from the UART receive buffer.

Section: Global Function Definitions

void LINRESP_ReceiveISR (void )[static]

Custom interrupt service routine for UART byte reception.

Section: Local Function Declarations

Section: Local Function Definitions

void LINRESP_RxCompleteCallbackRegister (void (*callback) void)

Registers a callback function for byte receive completion.

void LINRESP_RxDeinitialize (void )

Deinitializes the UART receiver.

void LINRESP_RxInitialize (void )

Initializes LIN receive operation.

void LINRESP_TxCompleteCallbackRegister (void (*callback) void)

Registers a callback function for byte transmit completion.

void LINRESP_TxInterruptDisable (void )

Disables the UART transmit interrupt.

void LINRESP_TxInterruptEnable (void )

Enables the UART transmit interrupt.

void LINRESP_Write (uint8_t txData)

Writes a byte of data to the UART transmit buffer.