Firmware
Public Types | Public Member Functions | Static Public Member Functions | List of all members
PWMSim Class Reference
Inheritance diagram for PWMSim:
cdev::CDev

Public Types

enum  Mode { MODE_8PWM, MODE_16PWM, MODE_NONE }
 

Public Member Functions

void run () override
 
int print_status () override
 
int ioctl (device::file_t *filp, int cmd, unsigned long arg) override
 Perform an ioctl operation on the device. More...
 
int set_pwm_rate (unsigned rate)
 
int set_mode (Mode mode)
 
Mode get_mode ()
 
- Public Member Functions inherited from cdev::CDev
 CDev (const char *devname)
 Constructor. More...
 
virtual int init ()
 
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...
 

Static Public Member Functions

static int task_spawn (int argc, char *argv[])
 
static PWMSiminstantiate (int argc, char *argv[])
 
static int custom_command (int argc, char *argv[])
 
static int print_usage (const char *reason=nullptr)
 

Additional Inherited Members

- 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.
 
- Protected Attributes inherited from cdev::CDev
px4_sem_t _lock
 lock to protect access to all class members (also for derived classes)
 
- 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.
 

Member Function Documentation

§ custom_command()

int PWMSim::custom_command ( int  argc,
char *  argv[] 
)
static
See also
ModuleBase

§ instantiate()

PWMSim * PWMSim::instantiate ( int  argc,
char *  argv[] 
)
static
See also
ModuleBase

§ ioctl()

int PWMSim::ioctl ( device::file_t filep,
int  cmd,
unsigned long  arg 
)
overridevirtual

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
filepPointer to the NuttX file structure.
cmdThe ioctl command value.
argThe ioctl argument value.
Returns
OK on success, or -errno otherwise.

Reimplemented from cdev::CDev.

§ print_status()

int PWMSim::print_status ( )
override
See also
ModuleBase::print_status()

§ print_usage()

int PWMSim::print_usage ( const char *  reason = nullptr)
static
See also
ModuleBase

§ run()

void PWMSim::run ( )
override
See also
ModuleBase::run()

§ task_spawn()

int PWMSim::task_spawn ( int  argc,
char *  argv[] 
)
static
See also
ModuleBase

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