/home/hillier_g/checkout/most4linux/most-kernel/rtmostsync.h File Reference

RTDM Profile for MOST Synchronous devices. More...

Go to the source code of this file.

Defines

#define RTDM_CLASS_MOSTSYNC   15
#define MOST_SYNC_RT_IOCTL_MAGIC   RTDM_CLASS_MOSTSYNC
IOCTLs
MOST Synchronous IOCTLs

#define MOST_SYNC_RT_SETUP_RX   _IOW(MOST_SYNC_RT_IOCTL_MAGIC, 0, struct frame_part)
#define MOST_SYNC_RT_SETUP_TX   _IOW(MOST_SYNC_RT_IOCTL_MAGIC, 1, struct frame_part)
#define MOST_SYNC_RT_MAXIOCTL   1
Sub-Classes of RTDM_CLASS_MOSTSYNC
Currently prepared only for this one subclass. Device naming mechanism must be changed if more subclasses are used.

This way, it's consitent with the Linux MOST driver.

#define RTDM_SUBCLASS_MOSTSYNC_OASIS   0


Detailed Description

RTDM Profile for MOST Synchronous devices.

Defines a device group for MOST Synchronous devices. It doesn't make sense to define a group for MOST in general, because the MOST NetServices part is handled by Linux in a non-realtime way and a device profile should determine how the device is programmed, and a MOST Synchronous device has nothing to do with a MOST Asynchronous device in its programming way.

While a synchronous device handles stream data and is accessed via device files in the Linux driver and the usual read/write calls in the real-time driver, an asynchronous device handles network data and is programmed with sockets.

Device Characteristics
Device Flags: RTDM_NAMED_DEVICE

Device Name: "mostsync<N>", N >= 0

Device Class: RTDM_CLASS_MOSTSYNC

Supported Operations
Open
Environments: non-RT
Specific return values: none

Close
Environments: non-RT
Specific return values: none

IOCTL
Environments: non-RT
See below

Read
Environments: RT
Specific return values:
Write
Environments: RT

Definition in file rtmostsync.h.


Define Documentation

#define RTDM_CLASS_MOSTSYNC   15

The device class for Synchronous MOST devices. Must be synchronised with addons/rtdm/rtdm.h or RTAI.

Definition at line 85 of file rtmostsync.h.

#define MOST_SYNC_RT_IOCTL_MAGIC   RTDM_CLASS_MOSTSYNC

Use the RTDM_CLASS_MOSTSYNC magic number for IOCTLs.

Definition at line 90 of file rtmostsync.h.

Referenced by most_sync_nrt_ioctl().

#define MOST_SYNC_RT_SETUP_RX   _IOW(MOST_SYNC_RT_IOCTL_MAGIC, 0, struct frame_part)

Setup ioctl() call. Performs following tasks:

This stops ALL reception on this device. The function call make take some while because it has to wait until each other file has finished the current reading/writing system call.

The function does not allocate any synchronous channels nor does it modify the routing engine. This has to be done with MOST NetServices. The frame_part argument contains the frame part from the view of the MOST PCI card, i.e. it's not the position of the part in the MOST frame but of the routed frames. See the documentation of the routing engine of the OS 8104 for details or the example code which comes with this driver.

Returns 0 on success, a negative error value on failure.

This service can be called from:

Definition at line 104 of file rtmostsync.h.

Referenced by most_sync_nrt_ioctl().

#define MOST_SYNC_RT_SETUP_TX   _IOW(MOST_SYNC_RT_IOCTL_MAGIC, 1, struct frame_part)

Setup ioctl() call. Performs following tasks:

This stops ALL transmission on this device. The function call make take some while because it has to wait until each other file has finished the current reading/writing system call.

The function does not allocate any synchronous channels nor does it modify the routing engine. This has to be done with MOST NetServices. The frame_part argument contains the frame part from the view of the MOST PCI card, i.e. it's not the position of the part in the MOST frame but of the routed frames. See the documentation of the routing engine of the OS 8104 for details or the example code which comes with this driver.

Returns 0 on success, a negative error value on failure.

This service can be called from:

Definition at line 113 of file rtmostsync.h.

Referenced by most_sync_nrt_ioctl().

#define MOST_SYNC_RT_MAXIOCTL   1

The maximum ioctl number. This value may change in future.

Definition at line 118 of file rtmostsync.h.


Generated on Fri Mar 9 14:48:58 2007 for MOST Linux Drivers (Linux and RTAI) by  doxygen 1.5.0