diff --git a/doc/libraw1394.sgml b/doc/libraw1394.sgml index 5d5a65b..d5c11bf 100644 --- a/doc/libraw1394.sgml +++ b/doc/libraw1394.sgml @@ -1,13 +1,14 @@ - - + libraw1394 - version 1.2.0 + version 2.0.4 - 2001-2004 + 2001-2009 Andreas Bombe, Dan Maas, Manfred Weihs, and Christian Toegel @@ -890,14 +891,21 @@ Function Reference - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_xmit_init + raw1394_iso_xmit_init + 9 + unknown kernel version raw1394_iso_xmit_init - initialize isochronous transmission + initialize isochronous transmission @@ -920,7 +928,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -928,7 +936,7 @@ handler - handler function for queueing packets + handler function for queueing packets @@ -936,7 +944,7 @@ buf_packets - number of isochronous packets to buffer + number of isochronous packets to buffer @@ -944,7 +952,7 @@ max_packet_size - largest packet you need to handle, in bytes + largest packet you need to handle, in bytes (not including the isochronous header) @@ -953,7 +961,7 @@ channel - isochronous channel on which to transmit + isochronous channel on which to transmit @@ -961,7 +969,7 @@ speed - speed at which to transmit + speed at which to transmit @@ -969,34 +977,42 @@ irq_interval - maximum latency of wake-ups, in packets (-1 if you don't care) + maximum latency of wake-ups, in packets (-1 if you don't care) - Description - +Description + Allocates all user and kernel resources necessary for isochronous transmission. - + Channel and bandwidth allocation at the IRM is not performed. + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_recv_init + raw1394_iso_recv_init + 9 + unknown kernel version raw1394_iso_recv_init - initialize isochronous reception + initialize isochronous reception @@ -1019,7 +1035,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1027,7 +1043,7 @@ handler - handler function for receiving packets + handler function for receiving packets @@ -1035,7 +1051,7 @@ buf_packets - number of isochronous packets to buffer + number of isochronous packets to buffer @@ -1043,7 +1059,7 @@ max_packet_size - largest packet you need to handle, in bytes (not including + largest packet you need to handle, in bytes (not including the isochronous header) @@ -1052,7 +1068,7 @@ channel - isochronous channel to receive + isochronous channel to receive @@ -1060,7 +1076,7 @@ mode - bufferfill or packet per buffer mode + bufferfill or packet per buffer mode @@ -1068,7 +1084,7 @@ irq_interval - maximum latency of wake-ups, in packets + maximum latency of wake-ups, in packets (-1 if you don't care) @@ -1076,27 +1092,34 @@ - Description - +Description + Allocates all user and kernel resources necessary for isochronous reception. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_multichannel_recv_init + raw1394_iso_multichannel_recv_init + 9 + unknown kernel version raw1394_iso_multichannel_recv_init - initialize multi-channel iso reception + initialize multi-channel iso reception @@ -1117,7 +1140,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1125,7 +1148,7 @@ handler - handler function for receiving packets + handler function for receiving packets @@ -1133,7 +1156,7 @@ buf_packets - number of isochronous packets to buffer + number of isochronous packets to buffer @@ -1141,7 +1164,7 @@ max_packet_size - largest packet you need to handle, in bytes (not including + largest packet you need to handle, in bytes (not including the isochronous header) @@ -1150,34 +1173,41 @@ irq_interval - maximum latency of wake-ups, in packets (-1 if you don't care) + maximum latency of wake-ups, in packets (-1 if you don't care) - Description - +Description + Allocates all user and kernel resources necessary for isochronous reception. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_recv_listen_channel + raw1394_iso_recv_listen_channel + 9 + unknown kernel version raw1394_iso_recv_listen_channel - listen to a specific channel in multi-channel mode + listen to a specific channel in multi-channel mode @@ -1195,7 +1225,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1203,34 +1233,41 @@ channel - the channel to start listening + the channel to start listening - Description - +Description + listen/unlisten on a specific channel (multi-channel mode ONLY) - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_recv_unlisten_channel + raw1394_iso_recv_unlisten_channel + 9 + unknown kernel version raw1394_iso_recv_unlisten_channel - stop listening to a specific channel in multi-channel mode + stop listening to a specific channel in multi-channel mode @@ -1248,7 +1285,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1256,28 +1293,35 @@ channel - the channel to stop listening to + the channel to stop listening to - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_recv_set_channel_mask + raw1394_iso_recv_set_channel_mask + 9 + unknown kernel version raw1394_iso_recv_set_channel_mask - listen or unlisten to a whole bunch of channels at once + listen or unlisten to a whole bunch of channels at once @@ -1295,7 +1339,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1303,7 +1347,7 @@ mask - 64-bit mask of channels, 1 means listen, 0 means unlisten, + 64-bit mask of channels, 1 means listen, 0 means unlisten, channel 0 is LSB, channel 63 is MSB @@ -1311,27 +1355,34 @@ - Description - +Description + for multi-channel reception mode only - + - Returns - - 0 on success, -1 on failure (sets errno) - +Returns + + 0 on success, -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_xmit_start + raw1394_iso_xmit_start + 9 + unknown kernel version raw1394_iso_xmit_start - begin isochronous transmission + begin isochronous transmission @@ -1350,7 +1401,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1358,7 +1409,7 @@ start_on_cycle - isochronous cycle number on which to start + isochronous cycle number on which to start (-1 if you don't care) @@ -1367,7 +1418,7 @@ prebuffer_packets - number of packets to queue up before starting transmission + number of packets to queue up before starting transmission (-1 if you don't care) @@ -1375,21 +1426,28 @@ - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_recv_start + raw1394_iso_recv_start + 9 + unknown kernel version raw1394_iso_recv_start - begin isochronous reception + begin isochronous reception @@ -1409,7 +1467,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1417,7 +1475,7 @@ start_on_cycle - isochronous cycle number on which to start + isochronous cycle number on which to start (-1 if you don't care) @@ -1426,7 +1484,7 @@ tag_mask - mask of tag fields to match (-1 to receive all packets) + mask of tag fields to match (-1 to receive all packets) @@ -1434,28 +1492,35 @@ sync - not used, reserved for future implementation + not used, reserved for future implementation - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_xmit_write + raw1394_iso_xmit_write + 9 + unknown kernel version raw1394_iso_xmit_write - alternative blocking-write API for ISO transmission + alternative blocking-write API for ISO transmission @@ -1476,7 +1541,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1484,7 +1549,7 @@ data - pointer to packet data buffer + pointer to packet data buffer @@ -1492,7 +1557,7 @@ len - length of packet, in bytes + length of packet, in bytes @@ -1500,7 +1565,7 @@ tag - tag field + tag field @@ -1508,37 +1573,44 @@ sy - sync field + sync field - Description - +Description + write style API - do NOT use this if you have set an xmit_handler if buffer is full, waits for more space UNLESS the file descriptor is set to non-blocking, in which case xmit_write will return -1 with errno = EAGAIN - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_xmit_sync + raw1394_iso_xmit_sync + 9 + unknown kernel version raw1394_iso_xmit_sync - wait until all queued packets have been sent + wait until all queued packets have been sent @@ -1555,28 +1627,35 @@ handle - libraw1394 handle + libraw1394 handle - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_recv_flush + raw1394_iso_recv_flush + 9 + unknown kernel version raw1394_iso_recv_flush - flush all already received iso packets from kernel into user space + flush all already received iso packets from kernel into user space @@ -1593,15 +1672,15 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + If you specified an irq_interval > 1 in iso_recv_init, you won't be notified for every single iso packet, but for groups of them. Now e.g. if irq_interval is 100, and you were just @@ -1610,24 +1689,31 @@ that there should be more packets at this moment, you can call this function and all iso packets which are already received by the kernel will be flushed out to user space. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_stop + raw1394_iso_stop + 9 + unknown kernel version raw1394_iso_stop - halt isochronous transmission or reception + halt isochronous transmission or reception @@ -1644,7 +1730,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1652,14 +1738,21 @@ - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_iso_shutdown + raw1394_iso_shutdown + 9 + unknown kernel version raw1394_iso_shutdown - clean up and deallocate all resources for isochronous transmission or reception + clean up and deallocate all resources for isochronous transmission or reception @@ -1676,7 +1769,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1684,14 +1777,97 @@ - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_errcode + raw1394_read_cycle_timer + 9 + unknown kernel version + + + raw1394_read_cycle_timer + + get the current value of the cycle timer + + + + Synopsis + + int raw1394_read_cycle_timer + raw1394handle_t handle + u_int32_t * cycle_timer + u_int64_t * local_time + + + + Arguments + + + handle + + + libraw1394 handle + + + + + cycle_timer + + + buffer for Isochronous Cycle Timer + + + + + local_time + + + buffer for local system time in microseconds since Epoch + + + + + + +Description + + Simultaneously reads the cycle timer register together with the system clock. + + + Format of cycle_timer, from MSB to LSB: 7 bits cycleSeconds (seconds, or + number of cycleCount rollovers), 13 bits cycleCount (isochronous cycles, or + cycleOffset rollovers), 12 bits cycleOffset (24.576 MHz clock ticks, not + provided on some hardware). The union of cycleSeconds and cycleCount is the + current cycle number. The nominal duration of a cycle is 125 microseconds. + + + +Returns + + the error code of the ioctl, or 0 if successful. + + + + + + + LINUX + Kernel Hackers Manual + August 2009 + + + raw1394_get_errcode + 9 + unknown kernel version raw1394_get_errcode - return error code of async transaction + return error code of async transaction @@ -1708,39 +1884,46 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + Some macros are available to extract information from the error code, raw1394_errcode_to_errno can be used to convert it to an errno number of roughly the same meaning. - + - Returns - - the error code of the last raw1394_read, raw1394_write, +Returns + + the error code of the last raw1394_read, raw1394_write, raw1394_lock. The error code is either an internal error (i.e. not a bus error) or a combination of acknowledge code and response code, as appropriate. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_errcode_to_errno + raw1394_errcode_to_errno + 9 + unknown kernel version raw1394_errcode_to_errno - convert libraw1394 errcode to errno + convert libraw1394 errcode to errno @@ -1757,15 +1940,15 @@ errcode - the error code to convert + the error code to convert - Description - +Description + The error code as retrieved by raw1394_get_errcode is converted into a roughly equivalent errno number and returned. 0xdead is returned for an illegal errcode. @@ -1776,27 +1959,34 @@ the conversion. However the returned errnos are equivalent in source code meaning only, the associated text of e.g. perror is not necessarily meaningful. - + - Returns - - EAGAIN (retrying might succeed, also generation number +Returns + + EAGAIN (retrying might succeed, also generation number mismatch), EREMOTEIO (other node had internal problems), EPERM (operation not allowed on this address, e.g. write on read-only location), EINVAL (invalid argument) and EFAULT (invalid pointer). - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_new_handle + raw1394_new_handle + 9 + unknown kernel version raw1394_new_handle - create new handle + create new handle @@ -1820,34 +2010,47 @@ - Description - +Description + Creates and returns a new handle which can (after being set up) control one port. It is not allowed to use the same handle in multiple threads or forked processes. It is allowed to create and use multiple handles, however. Use one handle per thread which needs it in the multithreaded case. - + + + The default device node is /dev/raw1394, but one can override the default + by setting environment variable RAW1394DEV. However, if RAW1394DEV points to + a non-existant or invalid device node, then it also attempts to open the + default device node. + - Returns - - the created handle or NULL when initialization fails. In the latter - case errno either contains some OS specific error code or 0 if the error is - that libraw1394 and raw1394 don't support each other's protocol versions. - +Returns + + the created handle or NULL when initialization fails. In the latter + case errno either contains some OS specific error code or EPROTO if + libraw1394 and raw1394 don't support each other's protocol versions. + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_destroy_handle + raw1394_destroy_handle + 9 + unknown kernel version raw1394_destroy_handle - deallocate handle + deallocate handle @@ -1864,30 +2067,37 @@ handle - handle to deallocate + handle to deallocate - Description - +Description + Closes connection with raw1394 on this handle and deallocates everything associated with it. It is safe to pass NULL as handle, nothing is done in this case. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_new_handle_on_port + raw1394_new_handle_on_port + 9 + unknown kernel version raw1394_new_handle_on_port - create a new handle and bind it to a port + create a new handle and bind it to a port @@ -1904,38 +2114,51 @@ port - port to connect to (same as argument to raw1394_set_port) + port to connect to (same as argument to raw1394_set_port) - Description - +Description + Same as raw1394_new_handle, but also binds the handle to the specified 1394 port. Equivalent to raw1394_new_handle followed by raw1394_get_port_info and raw1394_set_port. Useful for command-line programs that already know what port they want. If raw1394_set_port returns ESTALE, retries automatically. - + + + The default device node is /dev/raw1394, but one can override the default + by setting environment variable RAW1394DEV. However, if RAW1394DEV points to + a non-existant or invalid device node, then it also attempts to open the + default device node. + - Returns - - the new handle on success or NULL on failure - +Returns + + the new handle on success or NULL on failure + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_busreset_notify + raw1394_busreset_notify + 9 + unknown kernel version raw1394_busreset_notify - Switch off/on busreset-notification for handle + Switch off/on busreset-notification for handle @@ -1953,7 +2176,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -1961,28 +2184,35 @@ off_on_switch - RAW1394_NOTIFY_OFF or RAW1394_NOTIFY_ON + RAW1394_NOTIFY_OFF or RAW1394_NOTIFY_ON - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_fd + raw1394_get_fd + 9 + unknown kernel version raw1394_get_fd - get the communication file descriptor + get the communication file descriptor @@ -1999,38 +2229,46 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + This can be used for select/poll calls if you wait on other fds or can be integrated into another event loop (e.g. from a GUI application framework). It can also be used to set/remove the O_NONBLOCK flag using fcntl to modify the blocking behaviour in raw1394_loop_iterate. It must not be used for anything else. - + - Returns - - the fd used for communication with the raw1394 kernel module. - +Returns + + the fd used for communication with the raw1394 kernel module or -1 + on failure (sets errno). + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_set_userdata + raw1394_set_userdata + 9 + unknown kernel version raw1394_set_userdata - associate user data with a handle + associate user data with a handle @@ -2048,7 +2286,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2056,31 +2294,38 @@ data - user data (pointer) + user data (pointer) - Description - +Description + Allows to associate one void pointer with a handle. libraw1394 does not care about the data, it just stores it in the handle allowing it to be retrieved at any time with raw1394_get_userdata. This can be useful when multiple handles are used, so that callbacks can identify the handle. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_userdata + raw1394_get_userdata + 9 + unknown kernel version raw1394_get_userdata - retrieve user data from handle + retrieve user data from handle @@ -2097,29 +2342,36 @@ handle - libraw1394 handle + libraw1394 handle - Returns - - the user data pointer associated with the handle using +Returns + + the user data pointer associated with the handle using raw1394_set_userdata. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_local_id + raw1394_get_local_id + 9 + unknown kernel version raw1394_get_local_id - get node ID of the current port + get node ID of the current port @@ -2136,29 +2388,36 @@ handle - libraw1394 handle + libraw1394 handle - Returns - - the node ID of the local node connected to which the handle is +Returns + + the node ID of the local node connected to which the handle is connected. This value can change with every bus reset. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_irm_id + raw1394_get_irm_id + 9 + unknown kernel version raw1394_get_irm_id - get node ID of isochronous resource manager + get node ID of isochronous resource manager @@ -2175,29 +2434,36 @@ handle - libraw1394 handle + libraw1394 handle - Returns - - the node ID of the isochronous resource manager of the bus the handle +Returns + + the node ID of the isochronous resource manager of the bus the handle is connected to. This value may change with every bus reset. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_nodecount + raw1394_get_nodecount + 9 + unknown kernel version raw1394_get_nodecount - get number of nodes on the bus + get number of nodes on the bus @@ -2214,37 +2480,44 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + Since the root node always has the highest node ID, this number can be used to determine that ID (it's LOCAL_BUS|(count-1)). - + - Returns - - the number of nodes on the bus to which the handle is connected. +Returns + + the number of nodes on the bus to which the handle is connected. This value can change with every bus reset. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_port_info + raw1394_get_port_info + 9 + unknown kernel version raw1394_get_port_info - get information about available ports + get information about available ports @@ -2263,7 +2536,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2271,7 +2544,7 @@ pinf - pointer to an array of struct raw1394_portinfo + pointer to an array of struct raw1394_portinfo @@ -2279,15 +2552,15 @@ maxports - number of elements in pinf + number of elements in pinf - Description - +Description + Before you can set which port to use, you have to use this function to find out which ports exist. @@ -2297,25 +2570,32 @@ non-interactive program (and probably interactive ones, too) should provide a command line option to choose the port. If maxports is 0, pinf can be NULL, too. - + - Returns - - the number of ports and writes information about them into pinf, but +Returns + + the number of ports and writes information about them into pinf, but not into more than maxports elements. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_set_port + raw1394_set_port + 9 + unknown kernel version raw1394_set_port - choose port for handle + choose port for handle @@ -2333,7 +2613,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2341,41 +2621,48 @@ port - port to connect to (corresponds to index of struct raw1394_portinfo) + port to connect to (corresponds to index of struct raw1394_portinfo) - Description - +Description + This function connects the handle to the port given (as queried with raw1394_get_port_info). If successful, raw1394_get_port_info and raw1394_set_port are not allowed to be called afterwards on this handle. To make up for this, all the other functions (those handling asynchronous and isochronous transmissions) can now be called. - + - Returns - - 0 for success or -1 for failure with errno set appropriately. A +Returns + + 0 for success or -1 for failure with errno set appropriately. A possible failure mode is with errno = ESTALE, in this case the configuration has changed since the call to raw1394_get_port_info and it has to be called again to update your view of the available ports. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_reset_bus + raw1394_reset_bus + 9 + unknown kernel version raw1394_reset_bus - initiate bus reset + initiate bus reset @@ -2392,36 +2679,43 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + This function initiates a bus reset on the connected port. Usually this is not necessary and should be avoided, this function is here for low level bus control and debugging. - + - Returns - - 0 for success or -1 for failure with errno set appropriately - +Returns + + 0 for success or -1 for failure with errno set appropriately + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_reset_bus_new + raw1394_reset_bus_new + 9 + unknown kernel version raw1394_reset_bus_new - Reset the connected bus (with certain type). + Reset the connected bus (with certain type). @@ -2439,7 +2733,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2447,28 +2741,35 @@ type - RAW1394_SHORT_RESET or RAW1394_LONG_RESET + RAW1394_SHORT_RESET or RAW1394_LONG_RESET - Returns - - 0 for success or -1 for failure - +Returns + + 0 for success or -1 for failure + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_loop_iterate + raw1394_loop_iterate + 9 + unknown kernel version raw1394_loop_iterate - get and process one event message + get and process one event message @@ -2485,38 +2786,45 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + Get one new message through handle and process it with the registered message handler. Note that some other library functions may call this function multiple times to wait for their completion, some handler return values may get lost if you use these. - + - Returns - - -1 for an error or the return value of +Returns + + -1 for an error or the return value of the handler which got executed. The default handlers always return zero. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_set_bus_reset_handler + raw1394_set_bus_reset_handler + 9 + unknown kernel version raw1394_set_bus_reset_handler - set bus reset handler + set bus reset handler @@ -2534,7 +2842,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2542,35 +2850,42 @@ new_h - pointer to new handler + pointer to new handler - Description - +Description + Sets the handler to be called on every bus reset to new_h. The default handler just calls raw1394_update_generation. - + - Returns - - the old handler - +Returns + + the old handler or NULL on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_generation + raw1394_get_generation + 9 + unknown kernel version raw1394_get_generation - get generation number of handle + get generation number of handle @@ -2587,38 +2902,46 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + The generation number is incremented on every bus reset, and every transaction started by raw1394 is tagged with the stored generation number. If these don't match, the transaction will abort with an error. The generation number of the handle is not automatically updated, raw1394_update_generation has to be used for this. - + - Returns - - the generation number associated with the handle - +Returns + + the generation number associated with the handle or UINT_MAX on + failure. + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_update_generation + raw1394_update_generation + 9 + unknown kernel version raw1394_update_generation - set generation number of handle + set generation number of handle @@ -2636,7 +2959,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2644,15 +2967,15 @@ generation - new generation number + new generation number - Description - +Description + This function sets the generation number of the handle to gen. All requests that apply to a single node ID are tagged with this number and abort with an error if that is different from the generation number kept in the kernel. @@ -2661,18 +2984,25 @@ You should call this within your bus reset handler with an incremented value. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_set_tag_handler + raw1394_set_tag_handler + 9 + unknown kernel version raw1394_set_tag_handler - set request completion handler + set request completion handler @@ -2690,7 +3020,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2698,42 +3028,49 @@ new_h - pointer to new handler + pointer to new handler - Description - +Description + Sets the handler to be called whenever a request completes to new_h. The default handler interprets the tag as a pointer - to a &struct raw1394_reqhandle and calls the callback in there. + to a struct raw1394_reqhandle and calls the callback in there. Care must be taken when replacing the tag handler and calling the synchronous versions of the transaction functions (i.e. raw1394_read, raw1394_write, - raw1394_lock) since these do pass pointers to &struct - raw1394_reqhandle as the tag and expect the callback to be invoked. - + raw1394_lock) since these do pass pointers to struct + raw1394_reqhandle as the tag and expect the callback to be invoked. + - Returns - - the old handler - +Returns + + the old handler or NULL on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_set_arm_tag_handler + raw1394_set_arm_tag_handler + 9 + unknown kernel version raw1394_set_arm_tag_handler - set the async request handler + set the async request handler @@ -2751,7 +3088,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2759,36 +3096,43 @@ new_h - pointer to new handler + pointer to new handler - Description - +Description + Set the handler that will be called when an async read/write/lock arm_request arrived. The default action is to call the arm_callback in the raw1394_arm_reqhandle pointed to by arm_tag. - + - Returns - - old handler - +Returns + + old handler or NULL on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_set_fcp_handler + raw1394_set_fcp_handler + 9 + unknown kernel version raw1394_set_fcp_handler - set FCP handler + set FCP handler @@ -2806,7 +3150,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2814,15 +3158,15 @@ new_h - pointer to new handler + pointer to new handler - Description - +Description + Function Control Protocol is defined in IEC 61883-1. @@ -2830,31 +3174,38 @@ registers get written to new_h. The default handler does nothing. In order to actually get FCP events, you have to enable it with raw1394_start_fcp_listen and can stop it with raw1394_stop_fcp_listen. - + - Returns - - the old handler - +Returns + + the old handler or NULL on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -int + int + 9 + unknown kernel version int - This is the general request handler + This is the general request handler Synopsis typedef int - * req_callback_t + * req_callback_t @@ -2864,37 +3215,44 @@ req_callback_t - This is the general request handler + This is the general request handler - Description - +Description + It is used by the default tag handler when a request completes, it calls the callback and passes it the data pointer and the error code of the request. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -int + int + 9 + unknown kernel version int - This is the general arm-request handle + This is the general arm-request handle Synopsis typedef int - * arm_req_callback_t + * arm_req_callback_t @@ -2904,30 +3262,37 @@ arm_req_callback_t - This is the general arm-request handle + This is the general arm-request handle - Description - +Description + (arm = address range mapping) It is used by the default arm-tag handler when a request has been received, it calls the arm_callback. - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_arm_register + raw1394_arm_register + 9 + unknown kernel version raw1394_arm_register - register an AddressRangeMapping + register an AddressRangeMapping @@ -2951,7 +3316,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -2959,7 +3324,7 @@ start - identifies addressrange + identifies addressrange @@ -2967,7 +3332,7 @@ length - identifies addressrange + identifies addressrange @@ -2975,7 +3340,7 @@ initial_value - pointer to buffer containing (if necessary) initial value + pointer to buffer containing (if necessary) initial value NULL means undefined @@ -2984,7 +3349,7 @@ arm_tag - identifier for arm_tag_handler + identifier for arm_tag_handler (usually pointer to raw1394_arm_reqhandle) @@ -2993,7 +3358,7 @@ access_rights - access-rights for registered addressrange handled + access-rights for registered addressrange handled by kernel-part. Value is one or more binary or of the following flags - ARM_READ, ARM_WRITE, ARM_LOCK @@ -3003,7 +3368,7 @@ notification_options - identifies for which type of request you want + identifies for which type of request you want to be notified. Value is one or more binary or of the following flags - ARM_READ, ARM_WRITE, ARM_LOCK @@ -3013,7 +3378,7 @@ client_transactions - identifies for which type of request you want + identifies for which type of request you want to handle the request by the client application. for those requests no response will be generated, but has to be generated by the application. @@ -3027,27 +3392,34 @@ - Description - +Description + ARM = Adress Range Mapping - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_arm_unregister + raw1394_arm_unregister + 9 + unknown kernel version raw1394_arm_unregister - unregister an AddressRangeMapping + unregister an AddressRangeMapping @@ -3065,7 +3437,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3073,7 +3445,7 @@ start - identifies addressrange for unregistering + identifies addressrange for unregistering (value of start have to be the same value used for registering this adressrange) @@ -3082,21 +3454,28 @@ - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_arm_set_buf + raw1394_arm_set_buf + 9 + unknown kernel version raw1394_arm_set_buf - set the buffer of an AdressRangeMapping + set the buffer of an AdressRangeMapping @@ -3116,7 +3495,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3124,7 +3503,7 @@ start - identifies addressrange + identifies addressrange @@ -3132,7 +3511,7 @@ length - identifies addressrange + identifies addressrange @@ -3140,36 +3519,43 @@ buf - pointer to buffer + pointer to buffer - Description - +Description + This function copies length bytes from user memory area buf to one ARM block in kernel memory area with start offset start. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_arm_get_buf + raw1394_arm_get_buf + 9 + unknown kernel version raw1394_arm_get_buf - get the buffer of an AdressRangeMapping + get the buffer of an AdressRangeMapping @@ -3189,7 +3575,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3197,7 +3583,7 @@ start - identifies addressrange + identifies addressrange @@ -3205,7 +3591,7 @@ length - identifies addressrange + identifies addressrange @@ -3213,36 +3599,43 @@ buf - pointer to buffer + pointer to buffer - Description - +Description + This function copies length bytes from one ARM block in kernel memory area with start offset start to user memory area buf - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_echo_request + raw1394_echo_request + 9 + unknown kernel version raw1394_echo_request - send an echo request to the driver + send an echo request to the driver @@ -3260,7 +3653,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3268,36 +3661,43 @@ data - arbitrary data; raw1394_loop_iterate will return it + arbitrary data; raw1394_loop_iterate will return it - Description - +Description + the driver then send back the same request. raw1394_loop_iterate will return data as return value, when it processes the echo. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_wake_up + raw1394_wake_up + 9 + unknown kernel version raw1394_wake_up - wake up raw1394_loop_iterate + wake up raw1394_loop_iterate @@ -3314,35 +3714,42 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + (or a blocking read from the device file). actually this calls raw1394_echo_request with 0 as data. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_phy_packet_write + raw1394_phy_packet_write + 9 + unknown kernel version raw1394_phy_packet_write - send physical request + send physical request @@ -3360,7 +3767,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3368,34 +3775,41 @@ data - the contents of the packet + the contents of the packet - Description - +Description + examples of physical requests are linkon, physicalconfigurationpacket, etc. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_phy_packet_write + raw1394_start_phy_packet_write + 9 + unknown kernel version raw1394_start_phy_packet_write - initiate sending a physical request + initiate sending a physical request @@ -3414,7 +3828,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3422,7 +3836,7 @@ data - the contents of the packet + the contents of the packet @@ -3430,34 +3844,41 @@ tag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + examples of physical requests are linkon, physicalconfigurationpacket, etc. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_read + raw1394_start_read + 9 + unknown kernel version raw1394_start_read - initiate a read transaction + initiate a read transaction @@ -3479,7 +3900,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3487,7 +3908,7 @@ node - target node + target node ID @@ -3495,7 +3916,7 @@ addr - address to read from + address to read from @@ -3503,7 +3924,7 @@ length - amount of data to read + amount of bytes of data to read @@ -3511,7 +3932,7 @@ buffer - pointer to buffer where data will be saved + pointer to buffer where data will be saved @@ -3519,15 +3940,15 @@ tag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + This function starts the specified read request. If length is 4 a quadlet read is initiated and a block read otherwise. @@ -3538,24 +3959,31 @@ error code of the transaction. tag should therefore be set to something that uniquely identifies this transaction (e.g. a struct pointer casted to unsigned long). - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_write + raw1394_start_write + 9 + unknown kernel version raw1394_start_write - initiate a write transaction + initiate a write transaction @@ -3577,7 +4005,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3585,7 +4013,7 @@ node - target node + target node ID @@ -3593,7 +4021,7 @@ addr - address to write to + address to write to @@ -3601,7 +4029,7 @@ length - amount of data to write + amount of bytes of data to write @@ -3609,7 +4037,7 @@ data - pointer to data to be sent + pointer to data to be sent @@ -3617,15 +4045,15 @@ tag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + This function starts the specified write request. If length is 4 a quadlet write is initiated and a block write otherwise. @@ -3636,24 +4064,31 @@ error code of the transaction. tag should therefore be set to something that uniquely identifies this transaction (e.g. a struct pointer casted to unsigned long). - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_lock + raw1394_start_lock + 9 + unknown kernel version raw1394_start_lock - initiate a 32-bit compare-swap lock transaction + initiate a 32-bit compare-swap lock transaction @@ -3677,7 +4112,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3685,7 +4120,7 @@ node - target node + target node ID @@ -3693,7 +4128,7 @@ addr - address to read from + address to read from @@ -3701,7 +4136,7 @@ extcode - extended transaction code determining the lock operation + extended transaction code determining the lock operation @@ -3709,7 +4144,7 @@ data - data part of lock parameters + data part of lock parameters @@ -3717,7 +4152,7 @@ arg - arg part of lock parameters + arg part of lock parameters @@ -3725,7 +4160,7 @@ result - address where return value will be written + address where return value will be written @@ -3733,15 +4168,15 @@ tag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + This function starts the specified lock request. The transaction is only started, no success of the transaction is implied with a successful return of this function. When the transaction completes, a @@ -3749,24 +4184,31 @@ error code of the transaction. tag should therefore be set to something that uniquely identifies this transaction (e.g. a struct pointer casted to unsigned long). - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_lock64 + raw1394_start_lock64 + 9 + unknown kernel version raw1394_start_lock64 - initiate a 64-bit compare-swap lock transaction + initiate a 64-bit compare-swap lock transaction @@ -3790,7 +4232,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3798,7 +4240,7 @@ node - target node + target node ID @@ -3806,7 +4248,7 @@ addr - address to read from + address to read from @@ -3814,7 +4256,7 @@ extcode - extended transaction code determining the lock operation + extended transaction code determining the lock operation @@ -3822,7 +4264,7 @@ data - data part of lock parameters + data part of lock parameters @@ -3830,7 +4272,7 @@ arg - arg part of lock parameters + arg part of lock parameters @@ -3838,7 +4280,7 @@ result - address where return value will be written + address where return value will be written @@ -3846,15 +4288,15 @@ tag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + This function starts the specified lock request. The transaction is only started, no success of the transaction is implied with a successful return of this function. When the transaction completes, a @@ -3862,24 +4304,31 @@ error code of the transaction. tag should therefore be set to something that uniquely identifies this transaction (e.g. a struct pointer casted to unsigned long). - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_async_stream + raw1394_start_async_stream + 9 + unknown kernel version raw1394_start_async_stream - initiate asynchronous stream + initiate asynchronous stream @@ -3903,7 +4352,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -3911,7 +4360,7 @@ channel - the isochronous channel number to send on + the isochronous channel number to send on @@ -3919,7 +4368,7 @@ tag - data to be put into packet's tag field + data to be put into packet's tag field @@ -3927,7 +4376,7 @@ sy - data to be put into packet's sy field + data to be put into packet's sy field @@ -3935,7 +4384,7 @@ speed - speed at which to send + speed at which to send @@ -3943,7 +4392,7 @@ length - amount of data to send + amount of data to send, in bytes @@ -3951,7 +4400,7 @@ data - pointer to data to send + pointer to data to send @@ -3959,35 +4408,42 @@ rawtag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + Passes custom tag. Use pointer to raw1394_reqhandle if you use the standard tag handler. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_async_send + raw1394_start_async_send + 9 + unknown kernel version raw1394_start_async_send - send an asynchronous packet + send an asynchronous packet @@ -4009,7 +4465,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4017,7 +4473,7 @@ length - the amount of quadlets of data to send + the amount of bytes of data to send @@ -4025,7 +4481,7 @@ header_length - the number of quadlets in the header + the number of bytes in the header @@ -4033,7 +4489,7 @@ expect_response - indicate with a 0 or 1 whether to receive a completion event + indicate with a 0 or 1 whether to receive a completion event @@ -4041,7 +4497,7 @@ data - pointer to data to send + pointer to data to send @@ -4049,15 +4505,15 @@ rawtag - data to identify the request to completion handler + data to identify the request to completion handler - Description - +Description + This starts sending an arbitrary async packet. It gets an array of quadlets consisting of header and data (without CRC in between). Header information is always in machine byte order, data (data block as well as quadlet data @@ -4069,24 +4525,31 @@ transactions, that are handled by the application. Do not use that function, unless you really know, what you do! Sending corrupt packet may lead to weird results. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_read + raw1394_read + 9 + unknown kernel version raw1394_read - send async read request to a node and wait for response. + send async read request to a node and wait for response. @@ -4107,7 +4570,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4115,7 +4578,7 @@ node - target node + target node ID @@ -4123,7 +4586,7 @@ addr - address to read from + address to read from @@ -4131,7 +4594,7 @@ length - amount of data to read in quadlets + amount of bytes of data to read @@ -4139,36 +4602,46 @@ buffer - pointer to buffer where data will be saved + pointer to buffer where data will be saved - Description - +Description + + If length is 4, a quadlet read request is used. + + This does the complete transaction and will return when it's finished. It will call raw1394_loop_iterate as often as necessary, return values of handlers called will be therefore lost. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_write + raw1394_write + 9 + unknown kernel version raw1394_write - send async write request to a node and wait for response. + send async write request to a node and wait for response. @@ -4189,7 +4662,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4197,7 +4670,7 @@ node - target node + target node ID @@ -4205,7 +4678,7 @@ addr - address to write to + address to write to @@ -4213,7 +4686,7 @@ length - amount of data to write in quadlets + amount of bytes of data to write @@ -4221,36 +4694,46 @@ data - pointer to data to be sent + pointer to data to be sent - Description - +Description + + If length is 4, a quadlet write request is used. + + This does the complete transaction and will return when it's finished. It will call raw1394_loop_iterate as often as necessary, return values of handlers called will be therefore lost. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_lock + raw1394_lock + 9 + unknown kernel version raw1394_lock - send 32-bit compare-swap lock request and wait for response. + send 32-bit compare-swap lock request and wait for response. @@ -4273,7 +4756,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4281,7 +4764,7 @@ node - target node + target node ID @@ -4289,7 +4772,7 @@ addr - address to read from + address to read from @@ -4297,7 +4780,7 @@ extcode - extended transaction code determining the lock operation + extended transaction code determining the lock operation @@ -4305,7 +4788,7 @@ data - data part of lock parameters + data part of lock parameters @@ -4313,7 +4796,7 @@ arg - arg part of lock parameters + arg part of lock parameters @@ -4321,36 +4804,43 @@ result - address where return value will be written + address where return value will be written - Description - +Description + This does the complete transaction and will return when it's finished. It will call raw1394_loop_iterate as often as necessary, return values of handlers called will be therefore lost. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_lock64 + raw1394_lock64 + 9 + unknown kernel version raw1394_lock64 - send 64-bit compare-swap lock request and wait for response. + send 64-bit compare-swap lock request and wait for response. @@ -4373,7 +4863,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4381,7 +4871,7 @@ node - target node + target node ID @@ -4389,7 +4879,7 @@ addr - address to read from + address to read from @@ -4397,7 +4887,7 @@ extcode - extended transaction code determining the lock operation + extended transaction code determining the lock operation @@ -4405,7 +4895,7 @@ data - data part of lock parameters + data part of lock parameters @@ -4413,7 +4903,7 @@ arg - arg part of lock parameters + arg part of lock parameters @@ -4421,31 +4911,38 @@ result - address where return value will be written + address where return value will be written - Description - +Description + This does the complete transaction and will return when it's finished. It will call raw1394_loop_iterate as often as necessary, return values of handlers called will be therefore lost. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_async_stream + raw1394_async_stream + 9 + unknown kernel version raw1394_async_stream @@ -4472,7 +4969,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4480,7 +4977,7 @@ channel - the isochronous channel number to send on + the isochronous channel number to send on @@ -4488,7 +4985,7 @@ tag - data to be put into packet's tag field + data to be put into packet's tag field @@ -4496,7 +4993,7 @@ sy - data to be put into packet's sy field + data to be put into packet's sy field @@ -4504,7 +5001,7 @@ speed - speed at which to send + speed at which to send @@ -4512,7 +5009,7 @@ length - amount of data to send + amount of bytes of data to send @@ -4520,23 +5017,30 @@ data - pointer to data to send + pointer to data to send - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_async_send + raw1394_async_send + 9 + unknown kernel version raw1394_async_send @@ -4561,7 +5065,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4569,7 +5073,7 @@ length - the amount of quadlets of data to send + the amount of bytes of data to send @@ -4577,7 +5081,7 @@ header_length - the number of quadlets in the header + the number of bytes in the header @@ -4585,7 +5089,7 @@ expect_response - indicate with a 0 or 1 whether to receive a completion event + indicate with a 0 or 1 whether to receive a completion event @@ -4593,28 +5097,35 @@ data - pointer to data to send + pointer to data to send - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_start_fcp_listen + raw1394_start_fcp_listen + 9 + unknown kernel version raw1394_start_fcp_listen - enable reception of FCP events + enable reception of FCP events @@ -4631,37 +5142,44 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + FCP = Function Control Protocol (see IEC 61883-1) Enables the reception of FCP events (writes to the FCP_COMMAND or FCP_RESPONSE address ranges) on handle. FCP requests are then passed to the callback specified with raw1394_set_fcp_handler. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_stop_fcp_listen + raw1394_stop_fcp_listen + 9 + unknown kernel version raw1394_stop_fcp_listen - disable reception of FCP events + disable reception of FCP events @@ -4678,35 +5196,42 @@ handle - libraw1394 handle + libraw1394 handle - Description - +Description + Stops the reception of FCP events (writes to the FCP_COMMAND or FCP_RESPONSE address ranges) on handle. - + - Returns - - 0 on success or -1 on failure (sets errno) - +Returns + + 0 on success or -1 on failure (sets errno) + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_libversion + raw1394_get_libversion + 9 + unknown kernel version raw1394_get_libversion - Returns the version string + Returns the version string @@ -4730,30 +5255,37 @@ - Description - +Description + Instead, typically, one uses 'pkg-config --mod-version libraw1394' Might be useful for an application. - + - Returns - - a pointer to a string containing the version number - +Returns + + a pointer to a string containing the version number + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_update_config_rom + raw1394_update_config_rom + 9 + unknown kernel version raw1394_update_config_rom - updates the configuration ROM of a host + updates the configuration ROM of a host @@ -4761,7 +5293,7 @@ int raw1394_update_config_rom raw1394handle_t handle - const quadlet_t * new_rom + const quadlet_t * new_rom size_t size unsigned char rom_version @@ -4773,7 +5305,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4781,7 +5313,7 @@ new_rom - a pointer to the new ROM image + a pointer to the new ROM image @@ -4789,7 +5321,7 @@ size - the size of the new ROM image in quadlets + the size of the new ROM image in bytes @@ -4797,37 +5329,44 @@ rom_version - the version numer of the current version, not the new + the version numer of the current version, not the new - Description - +Description + rom_version must be the current version, otherwise it will fail with return value -1. - + - Returns - - -1 (failure) if the version is incorrect, +Returns + + -1 (failure) if the version is incorrect, -2 (failure) if the new rom version is too big, or 0 for success - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_get_config_rom + raw1394_get_config_rom + 9 + unknown kernel version raw1394_get_config_rom - reads the current version of the configuration ROM of a host + reads the current version of the configuration ROM of a host @@ -4848,7 +5387,7 @@ handle - libraw1394 handle + libraw1394 handle @@ -4856,7 +5395,7 @@ buffer - the memory address at which to store the copy of the ROM + the memory address at which to store the copy of the ROM @@ -4864,7 +5403,7 @@ buffersize - is the size of the buffer, rom_size + is the size of the buffer, rom_size @@ -4872,7 +5411,7 @@ rom_size - upon successful return, contains the size of the ROM + upon successful return, contains the size of the ROM @@ -4880,35 +5419,42 @@ rom_version - upon successful return, contains the version of the rom + upon successful return, contains the version of the rom - Description - +Description + returns the size of the current rom image. rom_version is the version number of the fetched rom. - + - Return - - -1 (failure) if the buffer was too small or 0 for success - +Return + + -1 (failure) if the buffer was too small or 0 for success + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_bandwidth_modify + raw1394_bandwidth_modify + 9 + unknown kernel version raw1394_bandwidth_modify - allocate or release bandwidth + allocate or release bandwidth @@ -4927,7 +5473,7 @@ handle - a libraw1394 handle + a libraw1394 handle @@ -4935,7 +5481,7 @@ bandwidth - IEEE 1394 Bandwidth Alloction Units + IEEE 1394 Bandwidth Alloction Units @@ -4943,34 +5489,41 @@ mode - whether to allocate or free + whether to allocate or free - Description - +Description + Communicates with the isochronous resource manager. - + - Return - +Return + -1 for failure, 0 for success - + - + + + LINUX + Kernel Hackers Manual + August 2009 + -raw1394_channel_modify + raw1394_channel_modify + 9 + unknown kernel version raw1394_channel_modify - allocate or release isochronous channel + allocate or release isochronous channel @@ -4989,7 +5542,7 @@ handle - a libraw1394 handle + a libraw1394 handle @@ -4997,7 +5550,7 @@ channel - isochronous channel + isochronous channel @@ -5005,23 +5558,23 @@ mode - whether to allocate or free + whether to allocate or free - Description - +Description + Communicates with the isochronous resource manager. - + - Return - +Return + -1 for failure, 0 for success - +