Abstract class for any character device. More...

#include <CDev.hpp>

Inheritance diagram for device::CDev:

Collaboration diagram for device::CDev:

Public Member Functions
	CDev (const char name, const char devname)
	Constructor. More...

virtual	~CDev ()=default

virtual int	init ()

virtual int	ioctl (file_t *filep, int cmd, unsigned long arg)
	Perform an ioctl operation on the device. More...

Public Member Functions inherited from device::Device
	Device (const Device &)=delete

Device &	operator= (const Device &)=delete

	Device (Device &&)=delete

Device &	operator= (Device &&)=delete

virtual	~Device ()=default
	Destructor. More...

virtual int	read (unsigned address, void *data, unsigned count)
	Read directly from the device. More...

virtual int	write (unsigned address, void *data, unsigned count)
	Write directly to the device. More...

virtual int	ioctl (unsigned operation, unsigned &arg)
	Perform a device-specific operation. More...

uint32_t	get_device_id () const

DeviceBusType	get_device_bus_type () const
	Return the bus type the device is connected to. More...

void	set_device_bus_type (DeviceBusType bus_type)

uint8_t	get_device_bus () const
	Return the bus ID the device is connected to. More...

void	set_device_bus (uint8_t bus)

uint8_t	get_device_address () const
	Return the bus address of the device. More...

void	set_device_address (int address)

uint8_t	get_device_type () const
	Return the device type. More...

void	set_device_type (uint8_t devtype)

virtual bool	external () const

Public Member Functions inherited from cdev::CDev
	CDev (const char *devname)
	Constructor. More...

	CDev (const CDev &)=delete

CDev &	operator= (const CDev &)=delete

	CDev (CDev &&)=delete

CDev &	operator= (CDev &&)=delete

virtual int	open (file_t *filep)
	Handle an open of the device. More...

virtual int	close (file_t *filep)
	Handle a close of the device. More...

virtual ssize_t	read (file_t filep, char buffer, size_t buflen)
	Perform a read from the device. More...

virtual ssize_t	write (file_t filep, const char buffer, size_t buflen)
	Perform a write to the device. More...

virtual off_t	seek (file_t *filep, off_t offset, int whence)
	Perform a logical seek operation on the device. More...

virtual int	poll (file_t filep, px4_pollfd_struct_t fds, bool setup)
	Perform a poll setup/teardown operation. More...

const char *	get_devname () const
	Get the device name. More...

Protected Attributes
bool	_pub_blocked {false}
	true if publishing should be blocked More...

Protected Attributes inherited from device::Device
const char *	_name {nullptr}
	driver name More...

bool	_debug_enabled {false}
	if true, debug messages are printed More...

Protected Attributes inherited from cdev::CDev
px4_sem_t	_lock
	lock to protect access to all class members (also for derived classes) More...

Additional Inherited Members
Public Types inherited from device::Device
enum	DeviceBusType { DeviceBusType_UNKNOWN = 0, DeviceBusType_I2C = 1, DeviceBusType_SPI = 2, DeviceBusType_UAVCAN = 3, DeviceBusType_SIMULATION = 4 }
	Device bus types for DEVID. More...

Static Public Member Functions inherited from device::Device
static const char *	get_device_bus_string (DeviceBusType bus)

static int	device_id_print_buffer (char *buffer, int length, uint32_t id)
	Print decoded device id string to a buffer. More...

Protected Member Functions inherited from device::Device
	Device (const char *name)

	Device (const char *name, DeviceBusType bus_type, uint8_t bus, uint8_t address, uint8_t devtype=0)

	Device (DeviceBusType bus_type, uint8_t bus, uint8_t address, uint8_t devtype=0)

Protected Member Functions inherited from cdev::CDev
virtual pollevent_t	poll_state (file_t *filep)
	Check the current state of the device for poll events from the perspective of the file. More...

virtual void	poll_notify (pollevent_t events)
	Report new poll events. More...

virtual void	poll_notify_one (px4_pollfd_struct_t *fds, pollevent_t events)
	Internal implementation of poll_notify. More...

virtual int	open_first (file_t *filep)
	Notification of the first open. More...

virtual int	close_last (file_t *filep)
	Notification of the last close. More...

virtual int	register_class_devname (const char *class_devname)
	Register a class device name, automatically adding device class instance suffix if need be. More...

virtual int	unregister_class_devname (const char *class_devname, unsigned class_instance)
	Register a class device name, automatically adding device class instance suffix if need be. More...

void	lock ()
	Take the driver lock. More...

void	unlock ()
	Release the driver lock. More...

int	unregister_driver_and_memory ()
	First, unregisters the driver. More...

Static Protected Attributes inherited from cdev::CDev
static const px4_file_operations_t	fops = {}
	Pointer to the default cdev file operations table; useful for registering clone devices etc. More...

Detailed Description

Abstract class for any character device.

Definition at line 60 of file CDev.hpp.

Constructor & Destructor Documentation

◆ CDev()

CDev::CDev	(	const char *	name,
		const char *	devname
	)

Constructor.

Parameters

name	Driver name
devname	Device node name

Definition at line 50 of file CDev.cpp.

◆ ~CDev()

virtual device::CDev::~CDev ( )

virtualdefault

Reimplemented from cdev::CDev.

Member Function Documentation

◆ init()

int CDev::init ( )

virtual

Reimplemented from cdev::CDev.

Reimplemented in QMC5883, RM3100, HMC5883, LIS3MDL, UavcanMagnetometerBridge, UavcanBarometerBridge, UavcanBatteryBridge, and UavcanFlowBridge.

Definition at line 57 of file CDev.cpp.

References DEVICE_DEBUG, cdev::CDev::get_devname(), cdev::CDev::init(), and device::Device::init().

Referenced by UavcanBatteryBridge::init(), UavcanFlowBridge::init(), UavcanBarometerBridge::init(), and UavcanMagnetometerBridge::init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ioctl()

int CDev::ioctl	(	file_t *	filep,
		int	cmd,
		unsigned long	arg
	)

virtual

Perform an ioctl operation on the device.

The default implementation handles DIOC_GETPRIV, and otherwise returns -ENOTTY. Subclasses should call the default implementation for any command they do not handle themselves.

Parameters

filep	Pointer to the NuttX file structure.
cmd	The ioctl command value.
arg	The ioctl argument value.

Returns: OK on success, or -errno otherwise.

Reimplemented from cdev::CDev.

Reimplemented in HMC5883.

Definition at line 82 of file CDev.cpp.

References _pub_blocked, and DEVICE_DEBUG.

Member Data Documentation

◆ _pub_blocked

bool device::CDev::_pub_blocked {false}

protected

true if publishing should be blocked

Definition at line 91 of file CDev.hpp.

Referenced by RM3100::collect(), LIS3MDL::collect(), QMC5883::collect(), HMC5883::collect(), and ioctl().

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

src/lib/drivers/device/CDev.hpp
src/lib/drivers/device/CDev.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CDev()

◆ ~CDev()

Member Function Documentation

◆ init()

◆ ioctl()

Member Data Documentation

◆ _pub_blocked