rtdm.h File Reference


Detailed Description

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

Note:
Copyright (C) 2005 Jan Kiszka <jan.kiszka@web.de>

Copyright (C) 2005 Joerg Langenberg <joerg.langenberg@gmx.net>

RTAI/fusion 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.

RTAI/fusion 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 RTAI/fusion; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Include dependency graph for rtdm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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_EXPERIMENTAL   224
#define RTDM_CLASS_MAX   255

Common IOCTLs

#define RTIOC_PURGE   _IOW(RTIOC_TYPE_COMMON, 0x10, int)
 Purge internal device buffers.

RTDM_PURGE_xxx_BUFFER

Flags selecting buffers to be purged

#define RTDM_PURGE_RX_BUFFER   0x0001
#define RTDM_PURGE_TX_BUFFER   0x0002

Defines

#define RTDM_MAX_DEVNAME_LEN   31
 Maximum length of device names.

Functions

int rt_dev_open (const char *path, int oflag,...)
 Open a device.
int rt_dev_socket (int protocol_family, int socket_type, int protocol)
 Create a socket.
int rt_dev_close (int fd)
 Close a device or socket.
int rt_dev_ioctl (int fd, int request,...)
 Issue an IOCTL.
ssize_t rt_dev_read (int fd, void *buf, size_t nbyte)
 Read from device.
ssize_t rt_dev_write (int fd, const void *buf, size_t nbyte)
 Write to device.
ssize_t rt_dev_recvmsg (int fd, struct msghdr *msg, int flags)
 Receive message from socket.
ssize_t rt_dev_sendmsg (int fd, const struct msghdr *msg, int flags)
 Transmit message to socket.
ssize_t rt_dev_recvfrom (int fd, void *buf, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen)
 Receive message from socket.


Define Documentation

#define RTIOC_PURGE   _IOW(RTIOC_TYPE_COMMON, 0x10, int)
 

Purge internal device buffers.

Parameters:
[in] arg Purge mask, see RTDM_PURGE_xxx_BUFFER


Generated on Sat Sep 3 12:32:49 2005 for RTAI Fusion API by  doxygen 1.4.2