Xenomai 3 Programmer's Reference Manual

Xenomai

3.0.3

Generated by Doxygen 1.8.10

Contents

1 API service tags 1

2 Deprecated List 3

3 Module Index 5

3.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4 Data Structure Index 7

6.2 Big dual kernel lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2.1 cobalt_atomic_enter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6.2.2.2 cobalt_atomic_leave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

6.2.2.3 RTDM_EXECUTE_ATOMICALLY . . . . . . . . . . . . . . . . . . . . . . 25

6.3 Spinlock with preemption deactivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

6.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

6.3.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

6.3.2.1 rtdm_lock_get_irqsave . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

6.3.3.4 rtdm_lock_put_irqrestore(rtdm_lock_t ∗lock, rtdm_lockctx_t context) . . . 30

iv CONTENTS

6.4 User-space driver core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

6.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

6.4.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

6.4.2.1 UDD_IRQ_CUSTOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

6.4.2.2 UDD_IRQ_NONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

6.4.2.3 UDD_MEM_LOGICAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

6.4.2.4 UDD_MEM_NONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

6.4.2.5 UDD_MEM_PHYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

6.4.3.2 udd_enable_irq(struct udd_device ∗udd, rtdm_event_t ∗done) . . . . . . . 34

6.4.3.3 udd_get_device(struct rtdm_fd ∗fd) . . . . . . . . . . . . . . . . . . . . . 35

6.4.3.4 udd_notify_event(struct udd_device ∗udd) . . . . . . . . . . . . . . . . . . 35

6.4.3.5 udd_register_device(struct udd_device ∗udd) . . . . . . . . . . . . . . . . 36

6.4.3.6 udd_unregister_device(struct udd_device ∗udd) . . . . . . . . . . . . . . 36

6.5 Thread state flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

6.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

6.5.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

6.5.2.1 XNHELD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

6.5.2.2 XNMIGRATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

6.7 CAN Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

6.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

6.7.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

6.7.2.1 CAN_CTRLMODE_3_SAMPLES . . . . . . . . . . . . . . . . . . . . . . 50

6.7.2.2 CAN_CTRLMODE_LISTENONLY . . . . . . . . . . . . . . . . . . . . . . 50

6.7.2.3 CAN_CTRLMODE_LOOPBACK . . . . . . . . . . . . . . . . . . . . . . . 50

6.7.2.4 CAN_ERR_LOSTARB_UNSPEC . . . . . . . . . . . . . . . . . . . . . . 50

6.7.2.5 CAN_RAW_ERR_FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . 50

6.7.2.6 CAN_RAW_FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

6.7.2.7 CAN_RAW_LOOPBACK . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Generated by Doxygen

CONTENTS v

6.7.2.8 CAN_RAW_RECV_OWN_MSGS . . . . . . . . . . . . . . . . . . . . . . 52

6.7.2.9 RTCAN_RTIOC_RCV_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . 52

6.7.2.10 RTCAN_RTIOC_SND_TIMEOUT . . . . . . . . . . . . . . . . . . . . . . 53

6.7.2.11 RTCAN_RTIOC_TAKE_TIMESTAMP . . . . . . . . . . . . . . . . . . . . 53

6.7.2.12 SIOCGCANBAUDRATE . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6.7.2.13 SIOCGCANCTRLMODE . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6.7.2.14 SIOCGCANCUSTOMBITTIME . . . . . . . . . . . . . . . . . . . . . . . . 54

6.7.2.15 SIOCGCANSTATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

6.7.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

6.7.3.1 can_filter_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

6.7.3.2 can_frame_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

6.7.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

6.7.4.1 CAN_BITTIME_TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

6.7.4.2 CAN_MODE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

6.7.4.3 CAN_STATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

6.8 RTDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

6.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

6.8.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

6.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

6.10 Serial Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

6.11 Testing Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

6.12 Real-time IPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

6.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

6.12.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

6.12.2.1 BUFP_BUFSZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

6.12.2.2 BUFP_LABEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

6.12.2.3 IDDP_LABEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

6.12.2.4 IDDP_POOLSZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Generated by Doxygen