PX4 Firmware
PX4 Autopilot Software http://px4.io
drv_orb_dev.h File Reference

uORB published object driver. More...

#include <px4_platform_common/defines.h>
#include <sys/types.h>
#include <sys/ioctl.h>
#include <stdint.h>
Include dependency graph for drv_orb_dev.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define _ORBIOCBASE   (0x2600)
 
#define _ORBIOC(_n)   (_PX4_IOC(_ORBIOCBASE, _n))
 
#define ORBIOCLASTUPDATE   _ORBIOC(10)
 Fetch the time at which the topic was last updated into *(uint64_t *)arg. More...
 
#define ORBIOCUPDATED   _ORBIOC(11)
 Check whether the topic has been updated since it was last read, sets *(bool *)arg. More...
 
#define ORBIOCSETINTERVAL   _ORBIOC(12)
 Set the minimum interval at which the topic can be seen to be updated for this subscription. More...
 
#define ORBIOCGADVERTISER   _ORBIOC(13)
 Get the global advertiser handle for the topic. More...
 
#define ORBIOCGPRIORITY   _ORBIOC(14)
 Get the priority for the topic. More...
 
#define ORBIOCSETQUEUESIZE   _ORBIOC(15)
 Set the queue size of the topic. More...
 
#define ORBIOCGETINTERVAL   _ORBIOC(16)
 Get the minimum interval at which the topic can be seen to be updated for this subscription. More...
 
#define ORBIOCISADVERTISED   _ORBIOC(17)
 Check whether the topic is advertised, sets *(unsigned long *)arg to 1 if advertised, 0 otherwise. More...
 

Detailed Description

uORB published object driver.

Definition in file drv_orb_dev.h.

Macro Definition Documentation

◆ _ORBIOC

#define _ORBIOC (   _n)    (_PX4_IOC(_ORBIOCBASE, _n))

Definition at line 49 of file drv_orb_dev.h.

◆ _ORBIOCBASE

#define _ORBIOCBASE   (0x2600)

Definition at line 48 of file drv_orb_dev.h.

◆ ORBIOCGADVERTISER

#define ORBIOCGADVERTISER   _ORBIOC(13)

Get the global advertiser handle for the topic.

Definition at line 65 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_advertise_multi().

◆ ORBIOCGETINTERVAL

#define ORBIOCGETINTERVAL   _ORBIOC(16)

Get the minimum interval at which the topic can be seen to be updated for this subscription.

Definition at line 74 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_get_interval().

◆ ORBIOCGPRIORITY

#define ORBIOCGPRIORITY   _ORBIOC(14)

Get the priority for the topic.

Definition at line 68 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_priority().

◆ ORBIOCISADVERTISED

#define ORBIOCISADVERTISED   _ORBIOC(17)

Check whether the topic is advertised, sets *(unsigned long *)arg to 1 if advertised, 0 otherwise.

Definition at line 77 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_exists().

◆ ORBIOCLASTUPDATE

#define ORBIOCLASTUPDATE   _ORBIOC(10)

Fetch the time at which the topic was last updated into *(uint64_t *)arg.

Definition at line 56 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_stat().

◆ ORBIOCSETINTERVAL

#define ORBIOCSETINTERVAL   _ORBIOC(12)

Set the minimum interval at which the topic can be seen to be updated for this subscription.

Definition at line 62 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_set_interval().

◆ ORBIOCSETQUEUESIZE

#define ORBIOCSETQUEUESIZE   _ORBIOC(15)

Set the queue size of the topic.

Definition at line 71 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_advertise_multi().

◆ ORBIOCUPDATED

#define ORBIOCUPDATED   _ORBIOC(11)

Check whether the topic has been updated since it was last read, sets *(bool *)arg.

Definition at line 59 of file drv_orb_dev.h.

Referenced by uORB::DeviceNode::ioctl(), and uORB::Manager::orb_check().