Fork us on GitHub Follow us on Facebook Follow us on Twitter

Changeset 42e2172 in mainline


Ignore:
Timestamp:
2011-05-07T08:18:03Z (9 years ago)
Author:
Vojtech Horky <vojtechhorky@…>
Branches:
master
Children:
beee81a
Parents:
e25a849
Message:

libusbvirt: doxygen comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • uspace/lib/usbvirt/src/ipc_hc.c

    re25a849 r42e2172  
    4343#include <usb/debug.h>
    4444
     45/** Send control read transfer to virtual USB device.
     46 *
     47 * @param phone IPC phone to the virtual device.
     48 * @param ep Target endpoint number.
     49 * @param setup_buffer Setup buffer.
     50 * @param setup_buffer_size Setup buffer size in bytes.
     51 * @param data_buffer Data buffer (DATA stage of control transfer).
     52 * @param data_buffer_size Size of data buffer in bytes.
     53 * @param data_transfered_size Number of actually transferred bytes.
     54 * @return Error code.
     55 */
    4556int usbvirt_ipc_send_control_read(int phone, usb_endpoint_t ep,
    4657    void *setup_buffer, size_t setup_buffer_size,
     
    92103}
    93104
     105/** Send control write transfer to virtual USB device.
     106 *
     107 * @param phone IPC phone to the virtual device.
     108 * @param ep Target endpoint number.
     109 * @param setup_buffer Setup buffer.
     110 * @param setup_buffer_size Setup buffer size in bytes.
     111 * @param data_buffer Data buffer (DATA stage of control transfer).
     112 * @param data_buffer_size Size of data buffer in bytes.
     113 * @return Error code.
     114 */
    94115int usbvirt_ipc_send_control_write(int phone, usb_endpoint_t ep,
    95116    void *setup_buffer, size_t setup_buffer_size,
     
    125146}
    126147
     148/** Request data transfer from virtual USB device.
     149 *
     150 * @param phone IPC phone to the virtual device.
     151 * @param ep Target endpoint number.
     152 * @param tr_type Transfer type (interrupt or bulk).
     153 * @param data Data buffer.
     154 * @param data_size Size of the data buffer in bytes.
     155 * @param act_size Number of actually returned bytes.
     156 * @return Error code.
     157 */
    127158int usbvirt_ipc_send_data_in(int phone, usb_endpoint_t ep,
    128159    usb_transfer_type_t tr_type, void *data, size_t data_size, size_t *act_size)
     
    167198}
    168199
     200/** Send data to virtual USB device.
     201 *
     202 * @param phone IPC phone to the virtual device.
     203 * @param ep Target endpoint number.
     204 * @param tr_type Transfer type (interrupt or bulk).
     205 * @param data Data buffer.
     206 * @param data_size Size of the data buffer in bytes.
     207 * @return Error code.
     208 */
    169209int usbvirt_ipc_send_data_out(int phone, usb_endpoint_t ep,
    170210    usb_transfer_type_t tr_type, void *data, size_t data_size)
Note: See TracChangeset for help on using the changeset viewer.