General Description

Constants to be used for select operation in call of l_ifc_ioctl().

Macros
#define	MTB_LIN_IOCTL_READ_STATUS (0x00U)
	Optional status indicators.

#define	MTB_LIN_IOCTL_SET_BAUD_RATE (0x01U)
	Set a baud rate.

#define	MTB_LIN_IOCTL_SLEEP (0x02U)
	Prepare the device for the Low-power mode entry.

#define	MTB_LIN_IOCTL_WAKEUP (0x03U)
	Restore the LIN middleware state after a wakeup.

#define	MTB_LIN_IOCTL_SYNC_COUNTS (0x04U)
	Return the current number of the sync field timer counts in "pv".

#define	MTB_LIN_IOCTL_SET_SERIAL_NUMBER (0x05U)
	Update the pointer to the serial number.

#define	MTB_LIN_IOCTL_GET_NAD (0x06U)
	Return the configured NAD.

#define	MTB_LIN_IOCTL_SET_NAD (0x07U)
	Set the configured NAD to any value except 00, 7E or 7F.

#define	MTB_LIN_IOCTL_GET_FRAME_PID (0x08U)
	Returns the frame PID by the frame table index.

#define	MTB_LIN_IOCTL_SET_FRAME_PID (0x09U)
	Sets the frame PID by the frame table index.

Macro Definition Documentation

◆ MTB_LIN_IOCTL_READ_STATUS

#define MTB_LIN_IOCTL_READ_STATUS (0x00U)

Optional status indicators.

The first bit in this byte is the flag that indicates there was no signalling on the bus for a certain elapsed time (available when the Bus Inactivity Timeout Detection option is enabled). If the elapsed time passes a certain threshold, this flag is set.

The second bit is the flag that indicates that a Targeted Reset service request (0xB5) is received (when J2602-1 Compliance is enabled).

Calling this API clears all the status bits after they are returned.

Parameters: The pointer to l_u16, where the status will be written.

◆ MTB_LIN_IOCTL_SET_BAUD_RATE

#define MTB_LIN_IOCTL_SET_BAUD_RATE (0x01U)

Set a baud rate.

Parameters: l_u16*.

◆ MTB_LIN_IOCTL_SLEEP

#define MTB_LIN_IOCTL_SLEEP (0x02U)

Prepare the device for the Low-power mode entry.

Parameters: None.

◆ MTB_LIN_IOCTL_WAKEUP

#define MTB_LIN_IOCTL_WAKEUP (0x03U)

Restore the LIN middleware state after a wakeup.

Parameters: None.

◆ MTB_LIN_IOCTL_SYNC_COUNTS

#define MTB_LIN_IOCTL_SYNC_COUNTS (0x04U)

Return the current number of the sync field timer counts in "pv".

Parameters: The pointer to l_u8, where the number will be written.

◆ MTB_LIN_IOCTL_SET_SERIAL_NUMBER

#define MTB_LIN_IOCTL_SET_SERIAL_NUMBER (0x05U)

Update the pointer to the serial number.

Parameters: The pointer to l_u8, where the serial number will be written.

◆ MTB_LIN_IOCTL_GET_NAD

#define MTB_LIN_IOCTL_GET_NAD (0x06U)

Return the configured NAD.

Parameters: The pointer to l_u8, where the NAD will be written.

◆ MTB_LIN_IOCTL_SET_NAD

#define MTB_LIN_IOCTL_SET_NAD (0x07U)

Set the configured NAD to any value except 00, 7E or 7F.

In J2602 compliance mode, frame PIDs are also updated according to the new NAD.

Parameters: The pointer to l_u8, where the NAD will be read from.

◆ MTB_LIN_IOCTL_GET_FRAME_PID

#define MTB_LIN_IOCTL_GET_FRAME_PID (0x08U)

Returns the frame PID by the frame table index.

Returns MTB_LIN_STATUS_INVALID_PID_INDEX if the specified index is out of range.

Parameters: The pointer to mtb_stc_lin_pid_t, where the PID will be written.

◆ MTB_LIN_IOCTL_SET_FRAME_PID

#define MTB_LIN_IOCTL_SET_FRAME_PID (0x09U)

Sets the frame PID by the frame table index.

Returns MTB_LIN_STATUS_INVALID_PID_INDEX if the specified index is out of range or the PID value is invalid.

Parameters: The pointer to mtb_stc_lin_pid_t, where the PID will be read from.