home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 4 / AUCD4.iso / acorn / riscos / releases / oslib / cstrong / CStrong / DeviceFS / HelpData next >
Text File  |  1994-09-26  |  18KB  |  361 lines
  1. devicefs_d
  2. Defined in:   <devicefs=>devicefs.$>.h
  3. Declaration:  typedef ... devicefs_d;devicefs_s
  4. Defined in:   <devicefs=>devicefs.$>.h
  5. Declaration:  typedef ... devicefs_s;devicefs_h
  6. Defined in:   <devicefs=>devicefs.$>.h
  7. Declaration:  typedef ... devicefs_h;devicefs_device
  8. Defined in:   <devicefs=>devicefs.$>.h
  9. Declaration:  typedef
  10.                  struct
  11.                  {  int name_offset;
  12.                     bits flags;
  13.                     bits rx_flags;
  14.                     int rx_buffer_size;
  15.                     bits tx_flags;
  16.                     int tx_buffer_size;
  17.                     int reserved;
  18.                  }
  19.                  devicefs_device;devicefs_device_list
  20. Defined in:   <devicefs=>devicefs.$>.h
  21. Declaration:  typedef
  22.                  struct
  23.                  {  <devicefs_device> d [...];
  24.                  }
  25.                  devicefs_device_list;devicefs_DEVICE_BUFFERED
  26. Defined in:   <devicefs=>devicefs.$>.h
  27. Declaration:  #define devicefs_DEVICE_BUFFERED 0x1udevicefs_DEVICE_USES_PATH_VAR
  28. Defined in:   <devicefs=>devicefs.$>.h
  29. Declaration:  #define devicefs_DEVICE_USES_PATH_VAR 0x2udevicefs_REGISTER_BLOCK_DEVICE
  30. Defined in:   <devicefs=>devicefs.$>.h
  31. Declaration:  #define devicefs_REGISTER_BLOCK_DEVICE 0x1udevicefs_REGISTER_FULL_DUPLEX
  32. Defined in:   <devicefs=>devicefs.$>.h
  33. Declaration:  #define devicefs_REGISTER_FULL_DUPLEX 0x2uxdevicefs_register
  34. Defined in:   <devicefs=>devicefs.$>.h
  35. Declaration:  extern <os_error=>os.os_error> *xdevicefs_register (bits flags,
  36.                  <devicefs_device_list> *devices,
  37.                  void *driver,
  38.                  int handle,
  39.                  void *workspace,
  40.                  char *validation,
  41.                  int rx_limit,
  42.                  int tx_limit,
  43.                  <devicefs_d> *d);
  44. Summary:      Registers a device driver and its associated devices with DeviceFSdevicefs_register
  45. Defined in:   <devicefs=>devicefs.$>.h
  46. Declaration:  extern <devicefs_d> devicefs_register (bits flags,
  47.                  <devicefs_device_list> *devices,
  48.                  void *driver,
  49.                  int handle,
  50.                  void *workspace,
  51.                  char *validation,
  52.                  int rx_limit,
  53.                  int tx_limit);
  54. Summary:      Registers a device driver and its associated devices with DeviceFSxdevicefs_deregister
  55. Defined in:   <devicefs=>devicefs.$>.h
  56. Declaration:  extern <os_error=>os.os_error> *xdevicefs_deregister (<devicefs_d> d);
  57. Summary:      Deregisters a device driver and all its devices from DeviceFSdevicefs_deregister
  58. Defined in:   <devicefs=>devicefs.$>.h
  59. Declaration:  extern void devicefs_deregister (<devicefs_d> d);
  60. Summary:      Deregisters a device driver and all its devices from DeviceFSxdevicefs_register_objects
  61. Defined in:   <devicefs=>devicefs.$>.h
  62. Declaration:  extern <os_error=>os.os_error> *xdevicefs_register_objects (<devicefs_d> d,
  63.                  <devicefs_device_list> *devices);
  64. Summary:      Registers a list of additional devices with a device driverdevicefs_register_objects
  65. Defined in:   <devicefs=>devicefs.$>.h
  66. Declaration:  extern void devicefs_register_objects (<devicefs_d> d,
  67.                  <devicefs_device_list> *devices);
  68. Summary:      Registers a list of additional devices with a device driverxdevicefs_deregister_objects
  69. Defined in:   <devicefs=>devicefs.$>.h
  70. Declaration:  extern <os_error=>os.os_error> *xdevicefs_deregister_objects (<devicefs_d> d,
  71.                  char *device_name);
  72. Summary:      Deregisters a device related to a particular device driverdevicefs_deregister_objects
  73. Defined in:   <devicefs=>devicefs.$>.h
  74. Declaration:  extern void devicefs_deregister_objects (<devicefs_d> d,
  75.                  char *device_name);
  76. Summary:      Deregisters a device related to a particular device driverxdevicefs_call_device
  77. Makes a call to a devicedevicefs_call_device
  78. Makes a call to a devicexdevicefscalldevice_initialise
  79. Defined in:   <devicefs=>devicefs.$>.h
  80. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_initialise (<devicefs_d> d,
  81.                  <devicefs_s> s,
  82.                  bits flags,
  83.                  byte *decoded_special,
  84.                  <devicefs_h> *h);
  85. Summary:      Initialises a devicedevicefscalldevice_initialise
  86. Defined in:   <devicefs=>devicefs.$>.h
  87. Declaration:  extern <devicefs_h> devicefscalldevice_initialise (<devicefs_d> d,
  88.                  <devicefs_s> s,
  89.                  bits flags,
  90.                  byte *decoded_special);
  91. Summary:      Initialises a devicexdevicefscalldevice_terminate
  92. Defined in:   <devicefs=>devicefs.$>.h
  93. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_terminate (<devicefs_d> d,
  94.                  <devicefs_h> h);
  95. Summary:      Finalises a devicedevicefscalldevice_terminate
  96. Defined in:   <devicefs=>devicefs.$>.h
  97. Declaration:  extern void devicefscalldevice_terminate (<devicefs_d> d,
  98.                  <devicefs_h> h);
  99. Summary:      Finalises a devicexdevicefscalldevice_tx_wake_up
  100. Defined in:   <devicefs=>devicefs.$>.h
  101. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_tx_wake_up (<devicefs_d> d,
  102.                  <devicefs_h> h,
  103.                  bool *woken_up);
  104. Summary:      Wakes a device up for transmissiondevicefscalldevice_tx_wake_up
  105. Defined in:   <devicefs=>devicefs.$>.h
  106. Declaration:  extern bool devicefscalldevice_tx_wake_up (<devicefs_d> d,
  107.                  <devicefs_h> h);
  108. Summary:      Wakes a device up for transmissionxdevicefscalldevice_rx_wake_up
  109. Defined in:   <devicefs=>devicefs.$>.h
  110. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_rx_wake_up (<devicefs_d> d,
  111.                  <devicefs_h> h);
  112. Summary:      Wakes a device up for receptiondevicefscalldevice_rx_wake_up
  113. Defined in:   <devicefs=>devicefs.$>.h
  114. Declaration:  extern void devicefscalldevice_rx_wake_up (<devicefs_d> d,
  115.                  <devicefs_h> h);
  116. Summary:      Wakes a device up for receptionxdevicefscalldevice_rx_sleep
  117. Defined in:   <devicefs=>devicefs.$>.h
  118. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_rx_sleep (<devicefs_d> d,
  119.                  <devicefs_h> h);
  120. Summary:      Puts a device to sleep from receptiondevicefscalldevice_rx_sleep
  121. Defined in:   <devicefs=>devicefs.$>.h
  122. Declaration:  extern void devicefscalldevice_rx_sleep (<devicefs_d> d,
  123.                  <devicefs_h> h);
  124. Summary:      Puts a device to sleep from receptionxdevicefscalldevice_enum_dir
  125. Defined in:   <devicefs=>devicefs.$>.h
  126. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_enum_dir (<devicefs_d> d,
  127.                  char *file_name);
  128. Summary:      Informs a device that a DeviceFS directory is being enumerateddevicefscalldevice_enum_dir
  129. Defined in:   <devicefs=>devicefs.$>.h
  130. Declaration:  extern void devicefscalldevice_enum_dir (<devicefs_d> d,
  131.                  char *file_name);
  132. Summary:      Informs a device that a DeviceFS directory is being enumeratedxdevicefscalldevice_tx_create_buffer
  133. Defined in:   <devicefs=>devicefs.$>.h
  134. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_tx_create_buffer (<devicefs_d> d,
  135.                  <devicefs_h> h,
  136.                  bits buffer_flags,
  137.                  int size,
  138.                  <buffer_b=>buffer.buffer_b> b,
  139.                  int threshold,
  140.                  bits *buffer_flags_out,
  141.                  int *size_out,
  142.                  <buffer_b=>buffer.buffer_b> *b_out,
  143.                  int *threshold_out);
  144. Summary:      Informs a device that a buffer is being created for transmissiondevicefscalldevice_tx_create_buffer
  145. Defined in:   <devicefs=>devicefs.$>.h
  146. Declaration:  extern <buffer_b=>buffer.buffer_b> devicefscalldevice_tx_create_buffer (<devicefs_d> d,
  147.                  <devicefs_h> h,
  148.                  bits buffer_flags,
  149.                  int size,
  150.                  <buffer_b=>buffer.buffer_b> b,
  151.                  int threshold,
  152.                  bits *buffer_flags_out,
  153.                  int *size_out,
  154.                  int *threshold_out);
  155. Summary:      Informs a device that a buffer is being created for transmissionxdevicefscalldevice_rx_create_buffer
  156. Defined in:   <devicefs=>devicefs.$>.h
  157. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_rx_create_buffer (<devicefs_d> d,
  158.                  <devicefs_h> h,
  159.                  bits buffer_flags,
  160.                  int size,
  161.                  <buffer_b=>buffer.buffer_b> b,
  162.                  int threshold,
  163.                  bits *buffer_flags_out,
  164.                  int *size_out,
  165.                  <buffer_b=>buffer.buffer_b> *b_out,
  166.                  int *threshold_out);
  167. Summary:      Informs a device that a buffer is being created for receptiondevicefscalldevice_rx_create_buffer
  168. Defined in:   <devicefs=>devicefs.$>.h
  169. Declaration:  extern <buffer_b=>buffer.buffer_b> devicefscalldevice_rx_create_buffer (<devicefs_d> d,
  170.                  <devicefs_h> h,
  171.                  bits buffer_flags,
  172.                  int size,
  173.                  <buffer_b=>buffer.buffer_b> b,
  174.                  int threshold,
  175.                  bits *buffer_flags_out,
  176.                  int *size_out,
  177.                  int *threshold_out);
  178. Summary:      Informs a device that a buffer is being created for receptionxdevicefscalldevice_halt
  179. Defined in:   <devicefs=>devicefs.$>.h
  180. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_halt (<devicefs_d> d,
  181.                  <devicefs_h> h);
  182. Summary:      Halts a devicedevicefscalldevice_halt
  183. Defined in:   <devicefs=>devicefs.$>.h
  184. Declaration:  extern void devicefscalldevice_halt (<devicefs_d> d,
  185.                  <devicefs_h> h);
  186. Summary:      Halts a devicexdevicefscalldevice_resume
  187. Defined in:   <devicefs=>devicefs.$>.h
  188. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_resume (<devicefs_d> d,
  189.                  <devicefs_h> h);
  190. Summary:      Resumes a devicedevicefscalldevice_resume
  191. Defined in:   <devicefs=>devicefs.$>.h
  192. Declaration:  extern void devicefscalldevice_resume (<devicefs_d> d,
  193.                  <devicefs_h> h);
  194. Summary:      Resumes a devicexdevicefscalldevice_end_of_data
  195. Defined in:   <devicefs=>devicefs.$>.h
  196. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_end_of_data (<devicefs_d> d,
  197.                  <devicefs_h> h,
  198.                  bool *end_of_data);
  199. Summary:      Returns the end-of-data status of a devicedevicefscalldevice_end_of_data
  200. Defined in:   <devicefs=>devicefs.$>.h
  201. Declaration:  extern bool devicefscalldevice_end_of_data (<devicefs_d> d,
  202.                  <devicefs_h> h);
  203. Summary:      Returns the end-of-data status of a devicexdevicefscalldevice_stream_created
  204. Defined in:   <devicefs=>devicefs.$>.h
  205. Declaration:  extern <os_error=>os.os_error> *xdevicefscalldevice_stream_created (<devicefs_d> d,
  206.                  <devicefs_h> h,
  207.                  <buffer_b=>buffer.buffer_b> b);
  208. Summary:      Informs a device that a stream has been createddevicefscalldevice_stream_created
  209. Defined in:   <devicefs=>devicefs.$>.h
  210. Declaration:  extern void devicefscalldevice_stream_created (<devicefs_d> d,
  211.                  <devicefs_h> h,
  212.                  <buffer_b=>buffer.buffer_b> b);
  213. Summary:      Informs a device that a stream has been createdxdevicefs_threshold
  214. Defined in:   <devicefs=>devicefs.$>.h
  215. Declaration:  extern <os_error=>os.os_error> *xdevicefs_threshold (<devicefs_s> s,
  216.                  int threshold);
  217. Summary:      Informs DeviceFS of the threshold value to use on buffered devicesdevicefs_threshold
  218. Defined in:   <devicefs=>devicefs.$>.h
  219. Declaration:  extern void devicefs_threshold (<devicefs_s> s,
  220.                  int threshold);
  221. Summary:      Informs DeviceFS of the threshold value to use on buffered devicesxdevicefs_received_char
  222. Defined in:   <devicefs=>devicefs.$>.h
  223. Declaration:  extern <os_error=>os.os_error> *xdevicefs_received_char (byte b,
  224.                  <devicefs_s> s,
  225.                  bits *psr);
  226. Summary:      Informs DeviceFS that a device has recieved a characterdevicefs_received_char
  227. Defined in:   <devicefs=>devicefs.$>.h
  228. Declaration:  extern bits devicefs_received_char (byte b,
  229.                  <devicefs_s> s);
  230. Summary:      Informs DeviceFS that a device has recieved a characterxdevicefs_transmit_char
  231. Defined in:   <devicefs=>devicefs.$>.h
  232. Declaration:  extern <os_error=>os.os_error> *xdevicefs_transmit_char (<devicefs_s> s,
  233.                  byte *b,
  234.                  bits *psr);
  235. Summary:      Informs DeviceFS that a device driver wants to transmit a characterdevicefs_transmit_char
  236. Defined in:   <devicefs=>devicefs.$>.h
  237. Declaration:  extern bits devicefs_transmit_char (<devicefs_s> s,
  238.                  byte *b);
  239. Summary:      Informs DeviceFS that a device driver wants to transmit a characterxservice_device_fs_starting
  240. Defined in:   <devicefs=>devicefs.$>.h
  241. Declaration:  extern <os_error=>os.os_error> *xservice_device_fs_starting (void);
  242. Summary:      DeviceFS is startingservice_device_fs_starting
  243. Defined in:   <devicefs=>devicefs.$>.h
  244. Declaration:  extern void service_device_fs_starting (void);
  245. Summary:      DeviceFS is startingxservice_device_fs_dying
  246. Defined in:   <devicefs=>devicefs.$>.h
  247. Declaration:  extern <os_error=>os.os_error> *xservice_device_fs_dying (void);
  248. Summary:      DeviceFS is dyingservice_device_fs_dying
  249. Defined in:   <devicefs=>devicefs.$>.h
  250. Declaration:  extern void service_device_fs_dying (void);
  251. Summary:      DeviceFS is dyingxservice_device_dead
  252. Defined in:   <devicefs=>devicefs.$>.h
  253. Declaration:  extern <os_error=>os.os_error> *xservice_device_dead (<devicefs_d> d,
  254.                  char *device_name);
  255. Summary:      Device has been killed by DeviceFSservice_device_dead
  256. Defined in:   <devicefs=>devicefs.$>.h
  257. Declaration:  extern void service_device_dead (<devicefs_d> d,
  258.                  char *device_name);
  259. Summary:      Device has been killed by DeviceFSxservice_device_fs_close_request
  260. Defined in:   <devicefs=>devicefs.$>.h
  261. Declaration:  extern <os_error=>os.os_error> *xservice_device_fs_close_request (<os_f=>os.os_f> file,
  262.                  bool *unclaimed);
  263. Summary:      Opening a device which already has the maximum number of streams openservice_device_fs_close_request
  264. Defined in:   <devicefs=>devicefs.$>.h
  265. Declaration:  extern bool service_device_fs_close_request (<os_f=>os.os_f> file);
  266. Summary:      Opening a device which already has the maximum number of streams openxupcall_stream_created
  267. Defined in:   <devicefs=>devicefs.$>.h
  268. Declaration:  extern <os_error=>os.os_error> *xupcall_stream_created (<devicefs_d> d,
  269.                  bool tx_stream,
  270.                  <os_f=>os.os_f> file,
  271.                  <devicefs_s> s);
  272. Summary:      Stream createdupcall_stream_created
  273. Defined in:   <devicefs=>devicefs.$>.h
  274. Declaration:  extern void upcall_stream_created (<devicefs_d> d,
  275.                  bool tx_stream,
  276.                  <os_f=>os.os_f> file,
  277.                  <devicefs_s> s);
  278. Summary:      Stream createdxupcall_stream_closed
  279. Defined in:   <devicefs=>devicefs.$>.h
  280. Declaration:  extern <os_error=>os.os_error> *xupcall_stream_closed (<devicefs_d> d,
  281.                  bool tx_stream,
  282.                  <os_f=>os.os_f> file,
  283.                  <devicefs_s> s);
  284. Summary:      Stream closedupcall_stream_closed
  285. Defined in:   <devicefs=>devicefs.$>.h
  286. Declaration:  extern void upcall_stream_closed (<devicefs_d> d,
  287.                  bool tx_stream,
  288.                  <os_f=>os.os_f> file,
  289.                  <devicefs_s> s);
  290. Summary:      Stream closedxevent_device_overrun
  291. Defined in:   <devicefs=>devicefs.$>.h
  292. Declaration:  extern <os_error=>os.os_error> *xevent_device_overrun (<devicefs_d> d,
  293.                  <os_f=>os.os_f> file);
  294. Summary:      Device overrun eventevent_device_overrun
  295. Defined in:   <devicefs=>devicefs.$>.h
  296. Declaration:  extern void event_device_overrun (<devicefs_d> d,
  297.                  <os_f=>os.os_f> file);
  298. Summary:      Device overrun eventDeviceFS
  299. <devicefs_d>
  300. <devicefs_s>
  301. <devicefs_h>
  302. <devicefs_device>
  303. <devicefs_device_list>
  304. <devicefs_DEVICE_BUFFERED>
  305. <devicefs_DEVICE_USES_PATH_VAR>
  306. <devicefs_REGISTER_BLOCK_DEVICE>
  307. <devicefs_REGISTER_FULL_DUPLEX>
  308. <xdevicefs_register>
  309. <devicefs_register>
  310. <xdevicefs_deregister>
  311. <devicefs_deregister>
  312. <xdevicefs_register_objects>
  313. <devicefs_register_objects>
  314. <xdevicefs_deregister_objects>
  315. <devicefs_deregister_objects>
  316. <xdevicefs_call_device>
  317. <devicefs_call_device>
  318. <xdevicefscalldevice_initialise>
  319. <devicefscalldevice_initialise>
  320. <xdevicefscalldevice_terminate>
  321. <devicefscalldevice_terminate>
  322. <xdevicefscalldevice_tx_wake_up>
  323. <devicefscalldevice_tx_wake_up>
  324. <xdevicefscalldevice_rx_wake_up>
  325. <devicefscalldevice_rx_wake_up>
  326. <xdevicefscalldevice_rx_sleep>
  327. <devicefscalldevice_rx_sleep>
  328. <xdevicefscalldevice_enum_dir>
  329. <devicefscalldevice_enum_dir>
  330. <xdevicefscalldevice_tx_create_buffer>
  331. <devicefscalldevice_tx_create_buffer>
  332. <xdevicefscalldevice_rx_create_buffer>
  333. <devicefscalldevice_rx_create_buffer>
  334. <xdevicefscalldevice_halt>
  335. <devicefscalldevice_halt>
  336. <xdevicefscalldevice_resume>
  337. <devicefscalldevice_resume>
  338. <xdevicefscalldevice_end_of_data>
  339. <devicefscalldevice_end_of_data>
  340. <xdevicefscalldevice_stream_created>
  341. <devicefscalldevice_stream_created>
  342. <xdevicefs_threshold>
  343. <devicefs_threshold>
  344. <xdevicefs_received_char>
  345. <devicefs_received_char>
  346. <xdevicefs_transmit_char>
  347. <devicefs_transmit_char>
  348. <xservice_device_fs_starting>
  349. <service_device_fs_starting>
  350. <xservice_device_fs_dying>
  351. <service_device_fs_dying>
  352. <xservice_device_dead>
  353. <service_device_dead>
  354. <xservice_device_fs_close_request>
  355. <service_device_fs_close_request>
  356. <xupcall_stream_created>
  357. <upcall_stream_created>
  358. <xupcall_stream_closed>
  359. <upcall_stream_closed>
  360. <xevent_device_overrun>
  361. <event_device_overrun>