diff options
Diffstat (limited to 'cpukit/include/rtems/io.h')
| -rw-r--r-- | cpukit/include/rtems/io.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h index 181da9fe4f..ecc89e16a2 100644 --- a/cpukit/include/rtems/io.h +++ b/cpukit/include/rtems/io.h @@ -228,6 +228,15 @@ typedef struct { * After a successful registration, the rtems_io_initialize() directive will be * called to initialize the device. * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_register_driver( rtems_device_major_number major, @@ -254,6 +263,15 @@ rtems_status_code rtems_io_register_driver( * * @par Notes * Currently no specific checks are made and the driver is not closed. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_unregister_driver( rtems_device_major_number major @@ -294,6 +312,15 @@ rtems_status_code rtems_io_unregister_driver( * hardware and data structures associated with a device. If necessary, it can * allocate memory to be used during other operations. * @endparblock + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_initialize( rtems_device_major_number major, @@ -322,6 +349,15 @@ rtems_status_code rtems_io_initialize( * * @par Notes * The device is registered as a character device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_register_name( const char *device_name, @@ -354,6 +390,15 @@ rtems_status_code rtems_io_register_name( * @par Notes * The open entry point is commonly used by device drivers to provide exclusive * access to a device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_open( rtems_device_major_number major, @@ -386,6 +431,15 @@ rtems_status_code rtems_io_open( * @par Notes * The close entry point is commonly used by device drivers to relinquish * exclusive access to a device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_close( rtems_device_major_number major, @@ -420,6 +474,15 @@ rtems_status_code rtems_io_close( * Read operations typically require a buffer address as part of the argument * parameter block. The contents of this buffer will be replaced with data * from the device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_read( rtems_device_major_number major, @@ -452,6 +515,15 @@ rtems_status_code rtems_io_read( * @par Notes * Write operations typically require a buffer address as part of the argument * parameter block. The contents of this buffer will be sent to the device. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_write( rtems_device_major_number major, @@ -489,6 +561,15 @@ rtems_status_code rtems_io_write( * device drivers are compatible. For example, an RS-232 driver I/O control * operation may change the baud of a serial line, while an I/O control * operation for a floppy disk driver may cause a seek operation. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive is not included in the pre-qualified feature set of RTEMS. + * Applications which are restricted to only use interfaces of the + * pre-qualified feature set of RTEMS shall not use the directive. + * @endparblock */ rtems_status_code rtems_io_control( rtems_device_major_number major, |