ctucanfd.h File Reference

This header file contains the implementation of CTU CAN FD controller. More...

Go to the source code of this file.

Macros
#define	RTEMS_CTUCANFD_NTXBUFS_MAX   ( 8 )
	This defines the maximum number of TX buffers.

Functions
struct rtems_can_chip *	rtems_ctucanfd_initialize (uintptr_t addr, rtems_vector_number irq, rtems_task_priority worker_priority, unsigned int ntxbufs, rtems_option irq_option, unsigned long can_clk_rate)
	This function initializes the CTU CAN FD controller.

Detailed Description

This header file contains the implementation of CTU CAN FD controller.

Macro Definition Documentation

RTEMS_CTUCANFD_NTXBUFS_MAX

#define RTEMS_CTUCANFD_NTXBUFS_MAX   ( 8 )

This defines the maximum number of TX buffers.

This is the maximum number of HW buffers that can be implemented to any CTU CAN FD core. The user can use this as an argument to initialization function rtems_ctucanfd_initialize and the function automatically limits the used buffers based on the used core.

Function Documentation

rtems_ctucanfd_initialize()

struct rtems_can_chip * rtems_ctucanfd_initialize	(	uintptr_t	addr,
		rtems_vector_number	irq,
		rtems_task_priority	worker_priority,
		unsigned int	ntxbufs,
		rtems_option	irq_option,
		unsigned long	can_clk_rate
	)

This function initializes the CTU CAN FD controller.

This is an entry point for CTU CAN FD controller initialization. This function allocates generic CAN and CTU CAN FD related structures, sets default values and initializes the resources (interrupt handler, semaphore. worker thread).

Parameters

addr	CTU CAN FD code base address.
irq	Interrupt number
worker_priotiry	The priority of TX/RX worker thread
ntxbufs	Number of TX hardware buffers to be used. The function automatically limits the maximum HW buffers based on the used core. You can use RTEMS_CTUCANFD_NTXBUFS_MAX to setup maximum available buffers.
irq_option	RTEMS_INTERRUPT_SHARED or RTEMS_INTERRUPT_UNIQUE
can_clk_rate	CAN clock rate.

Returns

Pointer to CAN chip structure on success, NULL otherwise.