LIN driver APIs. More...

Data Structures
struct	lin_timing_t

struct	lin_trans_config_t
	LIN config. More...

Enumerations
enum	lin_id_data_length_t { id_data_length_2bytes , id_data_length_2bytes_2 , id_data_length_4bytes , id_data_length_8bytes , id_data_length_2bytes , id_data_length_2bytes_2 , id_data_length_4bytes , id_data_length_8bytes }
	data length in ID bit4 and bit5 More...

enum	lin_bus_inactivity_time_t { bus_inactivity_time_4s , bus_inactivity_time_6s , bus_inactivity_time_8s , bus_inactivity_time_10s , bus_inactivity_time_4s , bus_inactivity_time_6s , bus_inactivity_time_8s , bus_inactivity_time_10s }
	bus inactivity tome to go to sleep More...

enum	lin_wakeup_repeat_time_t { wakeup_repeat_time_180ms , wakeup_repeat_time_200ms , wakeup_repeat_time_220ms , wakeup_repeat_time_240ms , wakeup_repeat_time_180ms , wakeup_repeat_time_200ms , wakeup_repeat_time_220ms , wakeup_repeat_time_240ms }
	wakeup repeat time More...

Functions
static uint8_t	lin_get_status (LIN_Type *ptr)
	lin get STATE register value More...

static void	lin_reset_interrupt (LIN_Type *ptr)
	lin reset interrupt More...

static void	lin_reset_error (LIN_Type *ptr)
	lin reset error More...

static void	lin_wakeup (LIN_Type *ptr)
	lin wakeup More...

static void	lin_sleep (LIN_Type *ptr)
	lin sleep More...

static void	lin_slave_stop (LIN_Type *ptr)
	lin slave stop More...

static void	lin_slave_ack (LIN_Type *ptr)
	lin slave ack More...

static void	lin_slave_set_bus_inactivity_time (LIN_Type *ptr, lin_bus_inactivity_time_t time)
	lin slave set bus inactivity time More...

static void	lin_slave_set_wakeup_repeat_time (LIN_Type *ptr, lin_wakeup_repeat_time_t time)
	lin slave set wakeup repeat time More...

static void	lin_set_mode (LIN_Type *ptr, bool master)
	lin set mode More...

static uint8_t	lin_get_data_byte (LIN_Type *ptr, uint8_t index)
	lin get data value in byte More...

static void	lin_write_data_byte (LIN_Type *ptr, uint8_t index, uint8_t data)
	lin write data value in byte More...

static bool	lin_is_active (LIN_Type *ptr)
	lin active status More...

static bool	lin_is_complete (LIN_Type *ptr)
	lin complete status More...

static uint8_t	lin_get_id (LIN_Type *ptr)
	lin get ID More...

hpm_stat_t	lin_master_configure_timing (LIN_Type ptr, lin_timing_t timing)
	lin configure timing on master mode More...

hpm_stat_t	lin_slave_configure_timing (LIN_Type *ptr, uint32_t src_freq_in_hz)
	lin config timing on slave mode More...

void	lin_master_transfer (LIN_Type ptr, lin_trans_config_t config)
	lin transfer on master mode More...

void	lin_slave_transfer (LIN_Type ptr, lin_trans_config_t config)
	lin transfer on slave mode More...

uint8_t	lin_get_data_length (LIN_Type *ptr)
	get data length More...

hpm_stat_t	lin_master_sent (LIN_Type ptr, lin_trans_config_t config)
	lin send data on master mode More...

hpm_stat_t	lin_master_receive (LIN_Type ptr, lin_trans_config_t config)
	lin receive data on master mode More...

hpm_stat_t	lin_slave_sent (LIN_Type ptr, lin_trans_config_t config)
	lin send data on slave mode More...

hpm_stat_t	lin_slave_receive (LIN_Type ptr, lin_trans_config_t config)
	lin receive data on slave mode More...

Detailed Description

LIN driver APIs.

Enumeration Type Documentation

◆ lin_bus_inactivity_time_t

enum lin_bus_inactivity_time_t

#include <drivers/inc/hpm_lin_drv.h>

bus inactivity tome to go to sleep

Enumerator
bus_inactivity_time_4s
bus_inactivity_time_6s
bus_inactivity_time_8s
bus_inactivity_time_10s
bus_inactivity_time_4s
bus_inactivity_time_6s
bus_inactivity_time_8s
bus_inactivity_time_10s

◆ lin_id_data_length_t

enum lin_id_data_length_t

#include <drivers/inc/hpm_lin_drv.h>

data length in ID bit4 and bit5

Enumerator
id_data_length_2bytes
id_data_length_2bytes_2	both 0 and 1 represent 2 bytes
id_data_length_4bytes
id_data_length_8bytes
id_data_length_2bytes
id_data_length_2bytes_2	both 0 and 1 represent 2 bytes
id_data_length_4bytes
id_data_length_8bytes

◆ lin_wakeup_repeat_time_t

enum lin_wakeup_repeat_time_t

#include <drivers/inc/hpm_lin_drv.h>

wakeup repeat time

Enumerator
wakeup_repeat_time_180ms
wakeup_repeat_time_200ms
wakeup_repeat_time_220ms
wakeup_repeat_time_240ms
wakeup_repeat_time_180ms
wakeup_repeat_time_200ms
wakeup_repeat_time_220ms
wakeup_repeat_time_240ms

Function Documentation

◆ lin_get_data_byte()

static uint8_t lin_get_data_byte	(	LIN_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin get data value in byte

Parameters

ptr	lin base address
index	byte index

Returns: uint8_t byte value

◆ lin_get_data_length()

uint8_t lin_get_data_length ( LIN_Type * ptr )

#include <drivers/inc/hpm_lin_drv.h>

get data length

Note: data length is determined by DATA_LEN register and ID

Parameters

ptr	lin base address

Returns: uint8_t data length

◆ lin_get_id()

static uint8_t lin_get_id ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin get ID

Parameters

ptr	lin base address

Returns: uint8_t ID value

◆ lin_get_status()

static uint8_t lin_get_status ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin get STATE register value

Parameters

[in] ptr lin base address

Returns: uint8_t STATE register value

◆ lin_is_active()

static bool lin_is_active ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin active status

Parameters

ptr	lin base address

Returns: bool true for active, false for inactive

◆ lin_is_complete()

static bool lin_is_complete ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin complete status

Parameters

ptr	lin base address

Returns: bool true for complete, false for incomplete

◆ lin_master_configure_timing()

hpm_stat_t lin_master_configure_timing	(	LIN_Type *	ptr,
		lin_timing_t *	timing
	)

#include <drivers/inc/hpm_lin_drv.h>

lin configure timing on master mode

Parameters

ptr	lin base address
timing	lin_timing_t

Returns: hpm_stat_t

set master mode

src =20MHz baudrate = 19.2KHz

bt_div = 260, scaler = 1, bt_mul = 0

◆ lin_master_receive()

hpm_stat_t lin_master_receive	(	LIN_Type *	ptr,
		lin_trans_config_t *	config
	)

#include <drivers/inc/hpm_lin_drv.h>

lin receive data on master mode

Parameters

ptr	lin base address
config	lin_trans_config_t

Returns: status_timeout; status_success

lin active

receive

start

waiting for receive complete

load register data into buffer

◆ lin_master_sent()

hpm_stat_t lin_master_sent	(	LIN_Type *	ptr,
		lin_trans_config_t *	config
	)

#include <drivers/inc/hpm_lin_drv.h>

lin send data on master mode

Parameters

ptr	lin base address
config	lin_trans_config_t

Returns: status_timeout; status_success

lin active

load data into registers

start

lin complete

◆ lin_master_transfer()

void lin_master_transfer	(	LIN_Type *	ptr,
		lin_trans_config_t *	config
	)

#include <drivers/inc/hpm_lin_drv.h>

lin transfer on master mode

Parameters

ptr	lin base address
config	lin_trans_config_t

sent or receive

start

◆ lin_reset_error()

static void lin_reset_error ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin reset error

Parameters

ptr	lin base address

◆ lin_reset_interrupt()

static void lin_reset_interrupt ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin reset interrupt

Parameters

ptr	lin base address

◆ lin_set_mode()

static void lin_set_mode	(	LIN_Type *	ptr,
		bool	master
	)

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin set mode

Parameters

ptr	lin base address
master	true for master mode, false for slave mode

◆ lin_slave_ack()

static void lin_slave_ack ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin slave ack

Parameters

ptr	lin base address

◆ lin_slave_configure_timing()

hpm_stat_t lin_slave_configure_timing	(	LIN_Type *	ptr,
		uint32_t	src_freq_in_hz
	)

#include <drivers/inc/hpm_lin_drv.h>

lin config timing on slave mode

Parameters

ptr	lin base address
src_freq_in_hz	source frequency

Returns: hpm_stat_t

set slave mode

src = 20MHz, prescaler = 1, bt_div = 250

◆ lin_slave_receive()

hpm_stat_t lin_slave_receive	(	LIN_Type *	ptr,
		lin_trans_config_t *	config
	)

#include <drivers/inc/hpm_lin_drv.h>

lin receive data on slave mode

Parameters

ptr	lin base address
config	lin_trans_config_t

Returns: status_timeout; status_success

lin data_req

receive

data ack

lin complete

◆ lin_slave_sent()

hpm_stat_t lin_slave_sent	(	LIN_Type *	ptr,
		lin_trans_config_t *	config
	)

#include <drivers/inc/hpm_lin_drv.h>

lin send data on slave mode

Parameters

ptr	lin base address
config	lin_trans_config_t

Returns: status_timeout; status_success

lin data_req

lin active?

transmit

data ack

lin complete

◆ lin_slave_set_bus_inactivity_time()

static void lin_slave_set_bus_inactivity_time	(	LIN_Type *	ptr,
		lin_bus_inactivity_time_t	time
	)

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin slave set bus inactivity time

Parameters

ptr	lin base address
time	lin_bus_inactivity_time_t

◆ lin_slave_set_wakeup_repeat_time()

static void lin_slave_set_wakeup_repeat_time	(	LIN_Type *	ptr,
		lin_wakeup_repeat_time_t	time
	)

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin slave set wakeup repeat time

Parameters

ptr	lin base address
time	lin_wakeup_repeat_time_t

◆ lin_slave_stop()

static void lin_slave_stop ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin slave stop

Parameters

ptr	lin base address

◆ lin_slave_transfer()

void lin_slave_transfer	(	LIN_Type *	ptr,
		lin_trans_config_t *	config
	)

#include <drivers/inc/hpm_lin_drv.h>

lin transfer on slave mode

Note: call this function after lin generate data request interrupt

Parameters

ptr	lin base address
config	lin_trans_config_t

transmit or receive

data ack

◆ lin_sleep()

static void lin_sleep ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin sleep

Parameters

ptr	lin base address

◆ lin_wakeup()

static void lin_wakeup ( LIN_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin wakeup

Parameters

ptr	lin base address

◆ lin_write_data_byte()

static void lin_write_data_byte	(	LIN_Type *	ptr,
		uint8_t	index,
		uint8_t	data
	)

inlinestatic

#include <drivers/inc/hpm_lin_drv.h>

lin write data value in byte

Parameters

ptr	lin base address
index	byte index
data	byte value

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ lin_bus_inactivity_time_t

◆ lin_id_data_length_t

◆ lin_wakeup_repeat_time_t

Function Documentation

◆ lin_get_data_byte()

◆ lin_get_data_length()

◆ lin_get_id()

◆ lin_get_status()

◆ lin_is_active()

◆ lin_is_complete()

◆ lin_master_configure_timing()

◆ lin_master_receive()

◆ lin_master_sent()

◆ lin_master_transfer()

◆ lin_reset_error()

◆ lin_reset_interrupt()

◆ lin_set_mode()

◆ lin_slave_ack()

◆ lin_slave_configure_timing()

◆ lin_slave_receive()

◆ lin_slave_sent()

◆ lin_slave_set_bus_inactivity_time()

◆ lin_slave_set_wakeup_repeat_time()

◆ lin_slave_stop()

◆ lin_slave_transfer()

◆ lin_sleep()

◆ lin_wakeup()

◆ lin_write_data_byte()