Specialization of I2C driver for STM32 devices. More...

#include <Stm32I2C.hxx>

Inheritance diagram for Stm32I2C:

Public Member Functions
	Stm32I2C (const char name, I2C_TypeDef port, uint32_t ev_interrupt, uint32_t er_interrupt)
	Constructor.

	~Stm32I2C ()
	Destructor.

void	event_interrupt_handler ()
	Call this function from the specific i2c interrupt routine in HwInit.

void	error_interrupt_handler ()
	Call this function from the specific i2c interrupt routine in HwInit.

void	complete_from_isr ()
	Internal. This function is called from the complete ISR callback.

void	error_from_isr ()
	Internal. This function is called from the error ISR callback.

Public Member Functions inherited from Device
	Device (const char *name)
	Constructor.

virtual	~Device ()
	Destructor.

Private Member Functions
void	enable () override
	function to enable device

void	disable () override
	function to disable device

int	transfer (struct i2c_msg *msg, bool stop) override
	Method to transmit/receive the data.

	Stm32I2C ()
	Default constructor.

	DISALLOW_COPY_AND_ASSIGN (Stm32I2C)

Private Attributes
I2C_HandleTypeDef	i2cHandle_
	Stm32 HAL device structure.

int	error_
	Pending transfer error field.

OSSem	sem
	Semaphore to wakeup task level from ISR.

Additional Inherited Members
Static Public Member Functions inherited from Device
static int	open (struct _reent reent, const char path, int flags, int mode)
	Open a file or device.

static int	close (struct _reent *reent, int fd)
	Close a file or device.

static int	stat (struct _reent reent, const char path, struct stat *stat)
	Get the status information of a file or device.

static int	select (int nfds, fd_set readfds, fd_set writefds, fd_set *exceptfds, long long timeout)
	POSIX select().

static void	select_clear ()
	Clears the current thread's select bits.

Static Public Member Functions inherited from FileIO
static ssize_t	read (struct _reent reent, int fd, void buf, size_t count)
	Read from a file or device.

static ssize_t	write (struct _reent reent, int fd, const void buf, size_t count)
	Write to a file or device.

static _off_t	lseek (struct _reent *reent, int fd, _off_t offset, int whence)
	Change the offset index of a file or device.

static int	fstat (struct _reent reent, int fd, struct stat stat)
	Get the status information of a file or device.

static int	ioctl (int fd, unsigned long int key, unsigned long data)
	Request and ioctl transaction.

static int	fcntl (int fd, int cmd, unsigned long data)
	Manipulate a file descriptor.

static bool	is_device (int fd)
	Test if the file descriptor belongs to a device.

Protected Member Functions inherited from I2C
	I2C (const char *name)
	Constructor.

	~I2C ()
	Destructor.

Protected Member Functions inherited from Node
	Node (const char *name)
	Constructor.

virtual	~Node ()
	Destructor.

int	open (File , const char , int, int) OVERRIDE
	Open method.

int	close (File *) OVERRIDE
	Close method.

virtual int	fstat (File file, struct stat stat) override
	Get the status information of a file or device.

Protected Member Functions inherited from FileIO
	FileIO (const char *name)
	Constructor.

virtual	~FileIO ()
	Destructor.

virtual off_t	lseek (File *f, off_t offset, int whence)
	Seek method.

virtual int	fcntl (File *file, int cmd, unsigned long data)
	Manipulate a file descriptor.

virtual bool	select (File *file, int mode)
	Device select method.

Static Protected Member Functions inherited from Device
static void	select_insert (SelectInfo *info)
	Add client to list of clients needing woken.

static void	select_wakeup (SelectInfo *info)
	Wakeup the list of clients needing woken.

static void	select_wakeup_from_isr (SelectInfo info, int woken)
	Wakeup the list of clients needing woken.

Static Protected Member Functions inherited from FileIO
static int	fd_alloc (void)
	Allocate a free file descriptor.

static void	fd_free (int fd)
	Free up a file descriptor.

static File *	file_lookup (int fd)
	Looks up a reference to a File corresponding to a given file descriptor.

static int	fd_lookup (File *file)
	Looks up a file descriptor corresponding to a given File reference.

Protected Attributes inherited from Node
OSMutex	lock_
	protects internal structures.

mode_t	mode_
	File open mode, such as O_NONBLOCK.

unsigned int	references_
	number of open references

Protected Attributes inherited from FileIO
const char *	name
	device name

Static Protected Attributes inherited from FileIO
static const unsigned int	numOpenFiles = 20

static File	files []
	File descriptor pool.

static OSMutex	mutex
	mutual exclusion for fileio

Detailed Description

Specialization of I2C driver for STM32 devices.

Definition at line 45 of file Stm32I2C.hxx.

Constructor & Destructor Documentation

◆ Stm32I2C()

Stm32I2C::Stm32I2C	(	const char *	name,
		I2C_TypeDef *	port,
		uint32_t	ev_interrupt,
		uint32_t	er_interrupt
	)

Constructor.

Parameters

name	name of this device instance in the file system
port	hardware instance of this device, e.g. I2C1
ev_interrupt	event interrupt vector number
er_interrupt	error interrupt vector number

Definition at line 167 of file Stm32I2C.cxx.

◆ ~Stm32I2C()

Stm32I2C::~Stm32I2C ( )

inline

Destructor.

Definition at line 59 of file Stm32I2C.hxx.

Member Function Documentation

◆ complete_from_isr()

void Stm32I2C::complete_from_isr ( )

inline

Internal. This function is called from the complete ISR callback.

Definition at line 263 of file Stm32I2C.cxx.

◆ disable()

void Stm32I2C::disable ( )

inlineoverrideprivatevirtual

function to disable device

Implements Node.

Definition at line 82 of file Stm32I2C.hxx.

◆ enable()

void Stm32I2C::enable ( )

inlineoverrideprivatevirtual

function to enable device

Implements Node.

Definition at line 81 of file Stm32I2C.hxx.

◆ error_from_isr()

void Stm32I2C::error_from_isr ( )

inline

Internal. This function is called from the error ISR callback.

Definition at line 270 of file Stm32I2C.cxx.

◆ error_interrupt_handler()

void Stm32I2C::error_interrupt_handler ( )

inline

Call this function from the specific i2c interrupt routine in HwInit.

Definition at line 70 of file Stm32I2C.hxx.

◆ event_interrupt_handler()

void Stm32I2C::event_interrupt_handler ( )

inline

Call this function from the specific i2c interrupt routine in HwInit.

Definition at line 64 of file Stm32I2C.hxx.

◆ transfer()

int Stm32I2C::transfer	(	struct i2c_msg *	msg,
		bool	stop
	)

overrideprivatevirtual

Method to transmit/receive the data.

Parameters

msg	message to transact.
stop	produce a stop condition at the end of the transfer

Returns: bytes transfered upon success, -errno upon failure

Implements I2C.

Definition at line 202 of file Stm32I2C.cxx.

Member Data Documentation

◆ error_

int Stm32I2C::error_

private

Pending transfer error field.

Definition at line 94 of file Stm32I2C.hxx.

◆ i2cHandle_

I2C_HandleTypeDef Stm32I2C::i2cHandle_

private

Stm32 HAL device structure.

Definition at line 92 of file Stm32I2C.hxx.

◆ sem

OSSem Stm32I2C::sem

private

Semaphore to wakeup task level from ISR.

Definition at line 96 of file Stm32I2C.hxx.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Stm32I2C()

◆ ~Stm32I2C()

Member Function Documentation

◆ complete_from_isr()

◆ disable()

◆ enable()

◆ error_from_isr()

◆ error_interrupt_handler()

◆ event_interrupt_handler()

◆ transfer()

Member Data Documentation

◆ error_

◆ i2cHandle_

◆ sem