Xenomai API  2.6.5
rtdm.h File Reference

Real-Time Driver Model for Xenomai, user API header. More...

#include <linux/types.h>
#include <linux/fcntl.h>
#include <linux/ioctl.h>
#include <linux/sched.h>
#include <linux/socket.h>
#include <asm/xenomai/wrappers.h>

Go to the source code of this file.

Data Structures

struct  rtdm_device_info
 Device information. More...
 

Macros

API Versioning

#define RTDM_API_VER   8
 Common user and driver API version.
 
#define RTDM_API_MIN_COMPAT_VER   6
 Minimum API revision compatible with the current release.
 
RTDM_TIMEOUT_xxx

Special timeout values

#define RTDM_TIMEOUT_INFINITE   0
 Block forever. More...
 
#define RTDM_TIMEOUT_NONE   (-1)
 Any negative timeout means non-blocking. More...
 
RTDM_CLASS_xxx

Device classes

#define RTDM_CLASS_PARPORT   1
 
#define RTDM_CLASS_SERIAL   2
 
#define RTDM_CLASS_CAN   3
 
#define RTDM_CLASS_NETWORK   4
 
#define RTDM_CLASS_RTMAC   5
 
#define RTDM_CLASS_TESTING   6
 
#define RTDM_CLASS_RTIPC   7
 
#define RTDM_CLASS_EXPERIMENTAL   224
 
#define RTDM_CLASS_MAX   255
 
Device Naming

Maximum length of device names (excluding the final null character)

#define RTDM_MAX_DEVNAME_LEN   31
 
RTDM_PURGE_xxx_BUFFER

Flags selecting buffers to be purged

#define RTDM_PURGE_RX_BUFFER   0x0001
 
#define RTDM_PURGE_TX_BUFFER   0x0002
 
Common IOCTLs

The following IOCTLs are common to all device profiles.

#define RTIOC_DEVICE_INFO   _IOR(RTIOC_TYPE_COMMON, 0x00, struct rtdm_device_info)
 Retrieve information about a device or socket. More...
 
#define RTIOC_PURGE   _IOW(RTIOC_TYPE_COMMON, 0x10, int)
 Purge internal device or socket buffers. More...
 

Typedefs

typedef uint64_t nanosecs_abs_t
 RTDM type for representing absolute dates. More...
 
typedef int64_t nanosecs_rel_t
 RTDM type for representing relative intervals. More...
 
typedef struct rtdm_device_info rtdm_device_info_t
 Device information.
 

Detailed Description

Real-Time Driver Model for Xenomai, user API header.

Note
Copyright (C) 2005, 2006 Jan Kiszka jan.k.nosp@m.iszk.nosp@m.a@web.nosp@m..de
Copyright (C) 2005 Joerg Langenberg joerg.nosp@m..lan.nosp@m.genbe.nosp@m.rg@g.nosp@m.mx.ne.nosp@m.t

Xenomai is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Xenomai is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Xenomai; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.