Modules
	CAN_Registers

Data Structures
struct	mxc_can_drv_version_t

struct	mxc_can_capabilities_t

struct	mxc_can_obj_capabilities_t

struct	mxc_can_stat_t

struct	mxc_can_msg_info_t

struct	mxc_can_req_t

Typedefs
typedef void(*	mxc_can_unit_event_cb_t) (uint32_t can_idx, uint32_t event)

Enumerations
enum	mxc_can_pwr_ctrl_t

enum	mxc_can_bitrate_sel_t

enum	mxc_can_mode_t

enum	mxc_can_filt_cfg_t

enum	mxc_can_obj_cfg_t

enum	mxc_can_ctrl_t

enum	mxc_can_unit_evt_t

enum	mxc_can_obj_evt_t

Functions
mxc_can_drv_version_t	MXC_CAN_GetVersion (void)

mxc_can_capabilities_t	MXC_CAN_GetCapabilities (void)

int	MXC_CAN_Init (uint32_t can_idx, mxc_can_obj_cfg_t cfg, mxc_can_unit_event_cb_t unit_cb, mxc_can_object_event_cb_t obj_cb)

int	MXC_CAN_UnInit (uint32_t can_idx)

int	MXC_CAN_PowerControl (uint32_t can_idx, mxc_can_pwr_ctrl_t pwr)

int	MXC_CAN_EnableInt (uint32_t can_idx, uint8_t en, uint8_t ext_en)

int	MXC_CAN_DisableInt (uint32_t can_idx, uint8_t dis, uint8_t ext_dis)

int	MXC_CAN_GetFlags (uint32_t can_idx, uint8_t flags, uint8_t ext_flags)

int	MXC_CAN_ClearFlags (uint32_t can_idx, uint8_t flags, uint8_t ext_flags)

int	MXC_CAN_GetClock (uint32_t can_idx)

int	MXC_CAN_GetBitRate (uint32_t can_idx, mxc_can_bitrate_sel_t sel)

int	MXC_CAN_SetBitRate (uint32_t can_idx, mxc_can_bitrate_sel_t sel, uint32_t bitrate, uint32_t bit_segments)

int	MXC_CAN_SetMode (uint32_t can_idx, mxc_can_mode_t mode)

mxc_can_obj_capabilities_t	MXC_CAN_ObjectGetCapabilities (uint32_t can_idx)

int	MXC_CAN_ObjectSetFilter (uint32_t can_idx, mxc_can_filt_cfg_t cfg, uint32_t id, uint32_t arg)

int	MXC_CAN_ObjectConfigure (uint32_t can_idx, mxc_can_obj_cfg_t cfg)

int	MXC_CAN_WriteTXFIFO (uint32_t can_idx, mxc_can_msg_info_t info, const uint8_t data, uint8_t size)

int	MXC_CAN_ReadRXFIFO (uint32_t can_idx, mxc_can_msg_info_t info, uint8_t data, uint8_t size)

int	MXC_CAN_MessageSend (uint32_t can_idx, mxc_can_req_t *req)

int	MXC_CAN_MessageSendAsync (uint32_t can_idx, mxc_can_req_t *req)

int	MXC_CAN_MessageSendDMA (uint32_t can_idx, mxc_can_req_t *req)

int	MXC_CAN_MessageRead (uint32_t can_idx, mxc_can_req_t *req)

int	MXC_CAN_MessageReadAsync (uint32_t can_idx, mxc_can_req_t *req)

int	MXC_CAN_MessageReadDMA (uint32_t can_idx, mxc_can_req_t req, void(dma_cb)(int, int))

int	MXC_CAN_Handler (uint32_t can_idx)

int	MXC_CAN_Control (uint32_t can_idx, mxc_can_ctrl_t ctrl, uint32_t ctrl_arg)

int	MXC_CAN_SetWakeupTimer (uint32_t can_idx, uint8_t prescaler, uint16_t wup_filter_tm, uint32_t wup_expire_tm)

void	MXC_CAN_SignalUnitEvent (uint32_t can_idx, mxc_can_unit_evt_t event)

void	MXC_CAN_SignalObjectEvent (uint32_t can_idx, mxc_can_obj_evt_t event)

Detailed Description

Data Structure Documentation

◆ mxc_can_drv_version_t

struct mxc_can_drv_version_t

Struct containing information about the version of the CAN library.

Data Fields
uint16_t	api

uint16_t	drv

◆ mxc_can_capabilities_t

struct mxc_can_capabilities_t

Struct containing the capabilities of the CAN driver.

Data Fields
uint32_t	num_objects

uint32_t	reentrant_operation

uint32_t	fd_mode

uint32_t	restricted_mode

uint32_t	monitor_mode

uint32_t	internal_loopback

uint32_t	external_loopback

uint32_t	rsv

◆ mxc_can_obj_capabilities_t

struct mxc_can_obj_capabilities_t

Struct containing information about the objects associated with a particular CAN driver.

Data Fields
int32_t	tx

int32_t	rx

int32_t	rx_rtr_tx_data

int32_t	tx_rtr_rx_data

int32_t	multiple_filters

int32_t	exact_filtering

int32_t	mask_filtering

int32_t	range_filtering

int32_t	message_depth

int32_t	reserved

◆ mxc_can_stat_t

struct mxc_can_stat_t

Struct detailing the current status of the CAN driver.

Data Fields
uint32_t	unit_state

uint32_t	last_error_code

uint32_t	tx_err_cnt

uint32_t	rx_err_cnt

uint32_t	can_idx

◆ mxc_can_msg_info_t

struct mxc_can_msg_info_t

Contains information about the message to be sent or the message received.

Data Fields
uint32_t	msg_id

uint32_t	rtr

uint32_t	fdf

uint32_t	brs

uint32_t	esi

uint32_t	dlc

uint32_t	rsv

◆ mxc_can_req_t

struct mxc_can_req_t

Struct containing information about CAN message.

Data Fields
mxc_can_msg_info_t *	msg_info

uint8_t *	data

uint8_t	data_sz

Enumeration Type Documentation

◆ mxc_can_bitrate_sel_t

enum mxc_can_bitrate_sel_t

Selects which bitrate to perform operation on.

Enumerator
MXC_CAN_BITRATE_SEL_NOMINAL	Set bitrate for classic CAN frames.
MXC_CAN_BITRATE_SEL_FD_DATA	Reserved for future use. Not supported on MAX32690, included to prevent build errors.

◆ mxc_can_ctrl_t

enum mxc_can_ctrl_t

Selects the control operation for the CAN driver to perform.

Enumerator
MXC_CAN_CTRL_SET_FD_MODE	No effect on MAX32690 (FD mode always enabled when CAN active)
MXC_CAN_CTRL_ABORT_TX	Abort transmission.
MXC_CAN_CTRL_RETRANSMISSION	Enable/disable auto retransmission on error.
MXC_CAN_CTRL_TRANSCEIVER_DLY	Set transceiver delay.

◆ mxc_can_filt_cfg_t

enum mxc_can_filt_cfg_t

Type used to select which operation to perform on message ID filter. Mask together one choice from each group to make configuration selection.

Enumerator
MXC_CAN_FILT_CFG_EXACT_ADD	Add exact filter.
MXC_CAN_FILT_CFG_EXACT_DEL	Remove exact filter.
MXC_CAN_FILT_CFG_RSV1	NOT SUPPORTED ON MAX32690.
MXC_CAN_FILT_CFG_RSV2	NOT SUPPORTED ON MAX32690.
MXC_CAN_FILT_CFG_MASK_ADD	Add maskable filter.
MXC_CAN_FILT_CFG_MASK_DEL	Remove maskable filter.
MXC_CAN_FILT_CFG_DUAL_GEN	Reccomended only for middleware use.
MXC_CAN_FILT_CFG_DUAL1_STD_ID	Perform operation on dual filter 1, for 11-bit message ID's.
MXC_CAN_FILT_CFG_DUAL1_EXT_ID	Perform operation on dual filter 1, for 29-bit message ID's.
MXC_CAN_FILT_CFG_DUAL2_STD_ID	Perform operation on dual filter 2, for 11-bit message ID's.
MXC_CAN_FILT_CFG_DUAL2_EXT_ID	Perform operation on dual filter 2, for 29-bit message ID's.
MXC_CAN_FILT_CFG_SINGLE_STD_ID	Perform operation on single filter, for 11-bit message ID's.
MXC_CAN_FILT_CFG_SINGLE_EXT_ID	Perform operation on single filter, for 29-bit message ID's.

◆ mxc_can_mode_t

enum mxc_can_mode_t

Selects the CAN driver's mode of operation.

Enumerator
MXC_CAN_MODE_INITIALIZATION	Reset mode.
MXC_CAN_MODE_NORMAL	Normal operating mode.
MXC_CAN_MODE_RESTRICTED	Restricted mode.
MXC_CAN_MODE_MONITOR	Listen-only mode.
MXC_CAN_MODE_LOOPBACK	Loopback mode.
MXC_CAN_MODE_RSV	Reserved for future use.
MXC_CAN_MODE_LOOPBACK_W_TXD	Loopback mode with transmit pin disconnected.

◆ mxc_can_obj_cfg_t

enum mxc_can_obj_cfg_t

Used to set the features available to a CAN object.

Enumerator
MXC_CAN_OBJ_CFG_INACTIVE	Object disabled.
MXC_CAN_OBJ_CFG_TXRX	Object can transmit and/or receive messages.
MXC_CAN_OBJ_CFG_RSV	Reserved for future use.
MXC_CAN_OBJ_CFG_RX_RTR_TX_DATA	NOT SUPPORTED ON MAX32690.
MXC_CAN_OBJ_CFG_TX_RTR_RX_DATA	NOT SUPPORTED ON MAX32690.

◆ mxc_can_obj_evt_t

enum mxc_can_obj_evt_t

Selects which object to notify/handle.

Enumerator
MXC_CAN_OBJ_EVT_TX_COMPLETE	Transmission complete.
MXC_CAN_OBJ_EVT_RX	Message received.
MXC_CAN_OBJ_EVT_RX_OVERRUN	RXFIFO overflow.

◆ mxc_can_pwr_ctrl_t

enum mxc_can_pwr_ctrl_t

Selects power state of the CAN peripherals.

Enumerator
MXC_CAN_PWR_CTRL_OFF	Shut off power to peripherals.
MXC_CAN_PWR_CTRL_SLEEP	Put peripherals to sleep.
MXC_CAN_PWR_CTRL_FULL	Peripherals fully awake.

◆ mxc_can_unit_evt_t

enum mxc_can_unit_evt_t

State which bus has entered to trigger unit event.

Enumerator
MXC_CAN_UNIT_EVT_INACTIVE	Peripherals entered inactive state (sleep, shutdown)
MXC_CAN_UNIT_EVT_ACTIVE	Peripherals entered active state.
MXC_CAN_UNIT_EVT_WARNING	Peripheral received error warning.
MXC_CAN_UNIT_EVT_PASSIVE	Peripheral entered passive state.
MXC_CAN_UNIT_EVT_BUS_OFF	Bus turned off.

Function Documentation

◆ MXC_CAN_ClearFlags()

int MXC_CAN_ClearFlags	(	uint32_t	can_idx,
		uint8_t	flags,
		uint8_t	ext_flags
	)

Clears interrupts flags.

Parameters

can_idx	Clear interrupt flags for CAN peripheral specified by this parameter (0 - CAN0, 1 - CAN1)
flags	Mask of interrupt flags to clear in INTFL register
ext_flags	Mask of interrupt flags to clear in EINTFL register

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_Control()

int MXC_CAN_Control	(	uint32_t	can_idx,
		mxc_can_ctrl_t	ctrl,
		uint32_t	ctrl_arg
	)

Perform control operation on CAN peripheral(s)

Parameters

can_idx	Index of CAN peripheral to perform control function on
ctrl	Operation to perform on the CAN peripherals
ctrl_arg	Depends on ctrl. RETRANSMISSION: 1-Enable, 0-Disable; TRANSCEIVER_DELAY: number of time quanta to delay; any other value of control this parameter is ignored

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, passing MXC_CAN_CTRL_SET_FD_MODE will return an error.

◆ MXC_CAN_DisableInt()

int MXC_CAN_DisableInt	(	uint32_t	can_idx,
		uint8_t	dis,
		uint8_t	ext_dis
	)

Disables interrupts in the interrupt and extended interrupt enable registers.

Parameters

can_idx	Index of the CAN peripheral to disable interrupts for (0 - CAN0, 1 - CAN1)
dis	Mask of interrupts to disable in the interrupt enable register
ext_dis	Mask of interrupts to disable in the extended interrupt enable register

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_EnableInt()

int MXC_CAN_EnableInt	(	uint32_t	can_idx,
		uint8_t	en,
		uint8_t	ext_en
	)

Enables interrupts in the interrupt and extended interrupt enable registetrs.

Parameters

can_idx	Index of the CAN peripheral to enable interrupts for (0 - CAN0, 1 - CAN1)
en	Mask of interrupts to enable in the interrupt enable register
ext_en	Mask of interrupts to enable in the extended interrupt enable register

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_GetBitRate()

int MXC_CAN_GetBitRate	(	uint32_t	can_idx,
		mxc_can_bitrate_sel_t	sel
	)

Returns the bit rate of the CAN clock.

Parameters

can_idx	Selects CAN peripheral (0 - CAN0, 1 - CAN1) to retrieve bit rate for
sel	Select which bitrate to return

Returns: Success/Fail, see Error Codes for a list of return codes. If successful, returns value of bit rate.

Warning: MAX32690 does not support CAN FD, passing MXC_CAN_BITRATE_SEL_FD_DATA will return an error.

◆ MXC_CAN_GetCapabilities()

mxc_can_capabilities_t MXC_CAN_GetCapabilities ( void )

Get information about the capabilities of the Maxim CAN SDK.

Returns: Struct containing capabilities information

◆ MXC_CAN_GetClock()

int MXC_CAN_GetClock ( uint32_t can_idx )

Returns the bit rate of the CAN clock.

Parameters

can_idx Index of CAN peripheral to get clock rate of

Returns: Frequency of CAN clock

◆ MXC_CAN_GetFlags()

int MXC_CAN_GetFlags	(	uint32_t	can_idx,
		uint8_t *	flags,
		uint8_t *	ext_flags
	)

Reads interrupt status flags.

Parameters

can_idx	Retrieve interrupt flags for CAN peripheral specified by this parameter (0 - CAN0, 1 - CAN1)
flags	Interrupt status flags in the INTFL register
ext_flags	Interrupt status flags in the EINTFL register

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_GetVersion()

mxc_can_drv_version_t MXC_CAN_GetVersion ( void )

Get information about the version of the CMSIS API and Maxim CAN SDK.

Returns: Struct containing version information

◆ MXC_CAN_Handler()

int MXC_CAN_Handler ( uint32_t can_idx )

General interrupt handler for MessageSendAsync and MessageReadAsync.

Parameters

can_idx Index of the CAN peripheral to handle interrupts for

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_Init()

int MXC_CAN_Init	(	uint32_t	can_idx,
		mxc_can_obj_cfg_t	cfg,
		mxc_can_unit_event_cb_t	unit_cb,
		mxc_can_object_event_cb_t	obj_cb
	)

Initializes CAN event callbacks.

Note: On default this function enables CAN peripheral clock and CAN gpio pins. if you wish to manage clock and gpio related things in upper level instead of here. Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. By this flag this function will remove clock and gpio related codes from file.

Parameters

can_idx	Index of the CAN peripheral to initialize
cfg	Specifies how to configure CAN peripheral (see MXC_CAN_ObjectConfigure)
unit_cb	Pointer to unit event callback function
obj_cb	Pointer to object event callback function

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_MessageRead()

int MXC_CAN_MessageRead	(	uint32_t	can_idx,
		mxc_can_req_t *	req
	)

Read received message if any. (this is a blocking function)

Parameters

can_idx	Index of the CAN peripheral to read the message for
req	Pointer to struct that stores CAN message information

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support receiving CAN FD messages.

◆ MXC_CAN_MessageReadAsync()

int MXC_CAN_MessageReadAsync	(	uint32_t	can_idx,
		mxc_can_req_t *	req
	)

Set up CAN device for asynchronus data receive (non-blocking)

Parameters

can_idx	Index of the CAN peripheral to set up asynchronus reads for
req	Pointer to struct that stores CAN message information

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support receiving CAN FD messages.; The structure pointed to by 'req' must remain unchanged and in scope until the RX complete event has been signaled.

◆ MXC_CAN_MessageReadDMA()

int MXC_CAN_MessageReadDMA	(	uint32_t	can_idx,
		mxc_can_req_t *	req,
		void(*)(int, int)	dma_cb
	)

Set up CAN device for DMA data receive.

Parameters

can_idx	Index of the CAN peripheral to receive data
req	Pointer to struct that stores CAN message information, initialize "msg_info" to expected configuration of the message to be received (Needed to ensure proper DMA length is set, if these are not known use MXC_CAN_MessageReadAsync instead.)
dma_cb	Pointer to DMA callback function.

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support receiving CAN FD messages.; The structure pointed to by 'req' must remain unchanged and in scope until the RX complete event has been signaled.

◆ MXC_CAN_MessageSend()

int MXC_CAN_MessageSend	(	uint32_t	can_idx,
		mxc_can_req_t *	req
	)

Send message (this is a blocking function).

Parameters

can_idx	Index of the CAN peripheral to send the message from
req	Contains information about the format and data of message to send

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, setting req->msg_info->fdf will return an error.

◆ MXC_CAN_MessageSendAsync()

int MXC_CAN_MessageSendAsync	(	uint32_t	can_idx,
		mxc_can_req_t *	req
	)

Send message (non-blocking).

Parameters

can_idx	Index of the CAN peripheral to send the message from
req	Contains information about the format and data of message to send

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, setting req->msg_info->fdf will return an error.; The structure pointed to by 'req' must remain unchanged and in scope until the TX complete event has been signaled.

◆ MXC_CAN_MessageSendDMA()

int MXC_CAN_MessageSendDMA	(	uint32_t	can_idx,
		mxc_can_req_t *	req
	)

Send message (non-blocking DMA).

Parameters

can_idx	Index of the CAN peripheral to send the message from
req	Contains information about the format and data of message to send

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, setting req->msg_info->fdf will return an error.; The structure pointed to by 'req' must remain unchanged and in scope until the TX complete event has been signaled.

◆ MXC_CAN_ObjectConfigure()

int MXC_CAN_ObjectConfigure	(	uint32_t	can_idx,
		mxc_can_obj_cfg_t	cfg
	)

Configure CAN object.

Note: On default this function enables CAN gpio pins. if you wish to manage gpio related things in upper level instead of here. Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. By this flag this function will remove gpio related codes from file.

Parameters

can_idx	Pointer to CAN instance
cfg	Specifies how the filter should be configured

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_ObjectGetCapabilities()

mxc_can_obj_capabilities_t MXC_CAN_ObjectGetCapabilities ( uint32_t can_idx )

Get the capabilities of the CAN object specified by can_idx.

Parameters

can_idx Index of the CAN peripheral to get capabilities of

Returns: Object capabilities information

◆ MXC_CAN_ObjectSetFilter()

int MXC_CAN_ObjectSetFilter	(	uint32_t	can_idx,
		mxc_can_filt_cfg_t	cfg,
		uint32_t	id,
		uint32_t	arg
	)

Setup message ID filter on CAN peripheral.

Parameters

can_idx	Pointer to CAN instance
cfg	Specifies how the filter should be configured
id	Exact ID for exact filter type. Base ID for maskable filter type.
arg	Mask for maskable filter type. Bits set to 0 are "don't care" bits and will always be accepted regardless of value, 1's are compared with ID. (Inverse of AMR register function.)

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_PowerControl()

int MXC_CAN_PowerControl	(	uint32_t	can_idx,
		mxc_can_pwr_ctrl_t	pwr
	)

Change Power state of the CAN peripherals.

Note: On default this function enables CAN peripheral clock. if you wish to manage clock related things in upper level instead of here. Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. By this flag this function will remove clock related codes from file.

Parameters

can_idx	Index of CAN peripheral to alter power settings for
pwr	Desired power state of the CAN peripherals

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_ReadRXFIFO()

int MXC_CAN_ReadRXFIFO	(	uint32_t	can_idx,
		mxc_can_msg_info_t *	info,
		uint8_t *	data,
		uint8_t	size
	)

Reads data from RX FIFO if data available.

Parameters

can_idx	Index of CAN peripheral to read RX data for
info	Pointer to struct to store message information in
data	Buffer to store received data bytes
size	Maximum number of data bytes that can be stored in "data"

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, setting info->fdf will return an error.

◆ MXC_CAN_SetBitRate()

int MXC_CAN_SetBitRate	(	uint32_t	can_idx,
		mxc_can_bitrate_sel_t	sel,
		uint32_t	bitrate,
		uint32_t	bit_segments
	)

Sets CAN clock frequency and sets time quanta values.

Parameters

can_idx	Index of CAN peripheral to set bitrate for
sel	Selects which bitrate to set (nominal/FD arbitration phase or FD data phase)
bitrate	Desired bitrate
bit_segments	Mask of number of time quanta in each bit segment see MXC_CAN_BIT_SEGMENTS(seg1_tq, seg2_tq, sjw_tq) defined above

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, passing MXC_CAN_BITRATE_SEL_FD_DATA will return an error.

◆ MXC_CAN_SetMode()

int MXC_CAN_SetMode	(	uint32_t	can_idx,
		mxc_can_mode_t	mode
	)

Sets the operating mode of the CAN peripherals.

Parameters

can_idx	Index of CAN peripheral
mode	Selects the mode of the CAN peripherals

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_SetWakeupTimer()

int MXC_CAN_SetWakeupTimer	(	uint32_t	can_idx,
		uint8_t	prescaler,
		uint16_t	wup_filter_tm,
		uint32_t	wup_expire_tm
	)

Configure wakeup timer settings (must be called before entering sleep mode)

Parameters

can_idx	Index of CAN peripheral to configure wakeup timer for
prescaler	Value to scale the CAN clock by to generate the wakup clock signal
wup_filter_tm	Value to set Wake-up filter time register to
wup_expire_tm	Value to set wake-up expire time register to

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_SignalObjectEvent()

void MXC_CAN_SignalObjectEvent	(	uint32_t	can_idx,
		mxc_can_obj_evt_t	event
	)

Notify object event handler of event that transpired.

Parameters

can_idx	Index of the CAN peripheral which had the event
event	Event that occured

◆ MXC_CAN_SignalUnitEvent()

void MXC_CAN_SignalUnitEvent	(	uint32_t	can_idx,
		mxc_can_unit_evt_t	event
	)

Notify unit event handler of event that transpired.

Parameters

can_idx	Index of CAN peripheral which the event transpired on
event	Event that occured

◆ MXC_CAN_UnInit()

int MXC_CAN_UnInit ( uint32_t can_idx )

Free CAN resources (does not reset or disable CAN peripherals)

Note: On default this function enables CAN peripheral clock. if you wish to manage clock related things in upper level instead of here. Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. By this flag this function will remove clock related codes from file.

Parameters

can_idx Index of CAN peripheral to un-initialize (shutdown)

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_CAN_WriteTXFIFO()

int MXC_CAN_WriteTXFIFO	(	uint32_t	can_idx,
		mxc_can_msg_info_t *	info,
		const uint8_t *	data,
		uint8_t	size
	)

Write data to be transmitted to TX FIFO (does not need to be called before message send)

Parameters

can_idx	Index of CAN peripheral to read RX data for
info	Pointer to struct containing information about the type of CAN message to send
data	Buffer of data bytes to be transmitted
size	Number of data bytes in "data"

Returns: Success/Fail, see Error Codes for a list of return codes.

Warning: MAX32690 does not support CAN FD, setting info->fdf will return an error.

Modules

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ mxc_can_drv_version_t

Data Fields

◆ mxc_can_capabilities_t

Data Fields

◆ mxc_can_obj_capabilities_t

Data Fields

◆ mxc_can_stat_t

Data Fields

◆ mxc_can_msg_info_t

Data Fields

◆ mxc_can_req_t

Data Fields

Enumeration Type Documentation

◆ mxc_can_bitrate_sel_t

◆ mxc_can_ctrl_t

◆ mxc_can_filt_cfg_t

◆ mxc_can_mode_t

◆ mxc_can_obj_cfg_t

◆ mxc_can_obj_evt_t

◆ mxc_can_pwr_ctrl_t

◆ mxc_can_unit_evt_t

Function Documentation

◆ MXC_CAN_ClearFlags()

◆ MXC_CAN_Control()

◆ MXC_CAN_DisableInt()

◆ MXC_CAN_EnableInt()

◆ MXC_CAN_GetBitRate()

◆ MXC_CAN_GetCapabilities()

◆ MXC_CAN_GetClock()

◆ MXC_CAN_GetFlags()

◆ MXC_CAN_GetVersion()

◆ MXC_CAN_Handler()

◆ MXC_CAN_Init()

◆ MXC_CAN_MessageRead()

◆ MXC_CAN_MessageReadAsync()

◆ MXC_CAN_MessageReadDMA()

◆ MXC_CAN_MessageSend()

◆ MXC_CAN_MessageSendAsync()

◆ MXC_CAN_MessageSendDMA()

◆ MXC_CAN_ObjectConfigure()

◆ MXC_CAN_ObjectGetCapabilities()

◆ MXC_CAN_ObjectSetFilter()

◆ MXC_CAN_PowerControl()

◆ MXC_CAN_ReadRXFIFO()

◆ MXC_CAN_SetBitRate()

◆ MXC_CAN_SetMode()

◆ MXC_CAN_SetWakeupTimer()

◆ MXC_CAN_SignalObjectEvent()

◆ MXC_CAN_SignalUnitEvent()

◆ MXC_CAN_UnInit()

◆ MXC_CAN_WriteTXFIFO()