Ignore:
Timestamp:
2011-12-14T15:29:41Z (13 years ago)
Author:
Jan Vesely <jano.vesely@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
a0487a2
Parents:
22ecbde
Message:

libusbdev: Doxygen and minor cleanup/renaming.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/usbdev/include/usb/dev/usb_device_connection.h

    r22ecbde r6e3c005  
    5252} usb_device_connection_t;
    5353
     54/** Initialize device connection. Set address and hc connection.
     55 * @param instance Structure to initialize.
     56 * @param hc_connection. Host controller connection to use.
     57 * @param address USB address.
     58 * @return Error code.
     59 */
    5460static inline int usb_device_connection_initialize(
    55     usb_device_connection_t *connection, usb_hc_connection_t *hc_connection,
     61    usb_device_connection_t *instance, usb_hc_connection_t *hc_connection,
    5662    usb_address_t address)
    5763{
    58         assert(connection);
     64        assert(instance);
    5965        if (hc_connection == NULL)
    6066                return EBADMEM;
    … …  
    6268                return EINVAL;
    6369
    64         connection->hc_connection = hc_connection;
    65         connection->address = address;
     70        instance->hc_connection = hc_connection;
     71        instance->address = address;
    6672        return EOK;
    6773}
    6874/*----------------------------------------------------------------------------*/
    69 static inline int usb_device_register_endpoint(usb_device_connection_t *conn,
    70     usb_endpoint_t ep, usb_transfer_type_t type, usb_direction_t direction,
     75/** Register endpoint on the device.
     76 * @param instance device connection structure to use.
     77 * @param ep USB endpoint number.
     78 * @param type Communication type of the endpoint.
     79 * @param direction Communication direction.
     80 * @param packet_size Maximum packet size for the endpoint.
     81 * @param interval Preferrred interval between communication.
     82 * @return Error code.
     83 */
     84static inline int usb_device_register_endpoint(
     85    usb_device_connection_t *instance, usb_endpoint_t ep,
     86    usb_transfer_type_t type, usb_direction_t direction,
    7187    size_t packet_size, unsigned interval)
    7288{
    73         assert(conn);
    74         return usb_hc_register_endpoint(conn->hc_connection,
    75             conn->address, ep, type, direction, packet_size, interval);
     89        assert(instance);
     90        return usb_hc_register_endpoint(instance->hc_connection,
     91            instance->address, ep, type, direction, packet_size, interval);
    7692}
    7793/*----------------------------------------------------------------------------*/
    78 static inline int usb_device_unregister_endpoint(usb_device_connection_t *conn,
    79     usb_endpoint_t ep, usb_direction_t direction)
     94/** Unregister endpoint on the device.
     95 * @param instance device connection structure
     96 * @param ep Endpoint number.
     97 * @param dir Communication direction.
     98 * @return Error code.
     99 */
     100static inline int usb_device_unregister_endpoint(
     101    usb_device_connection_t *instance, usb_endpoint_t ep, usb_direction_t dir)
    80102{
    81         assert(conn);
    82         return usb_hc_unregister_endpoint(conn->hc_connection,
    83             conn->address, ep, direction);
     103        assert(instance);
     104        return usb_hc_unregister_endpoint(instance->hc_connection,
     105            instance->address, ep, dir);
    84106}
    85107/*----------------------------------------------------------------------------*/
    86 static inline int usb_device_control_read(usb_device_connection_t *conn,
     108/** Get data from the device.
     109 * @param[in] instance device connection structure to use.
     110 * @param[in] ep target endpoint's number.
     111 * @param[in] setup Setup stage data (control transfers).
     112 * @param[in] data data buffer.
     113 * @param[in] size size of the data buffer.
     114 * @param[out] rsize bytes actually copied to the buffer.
     115 * @return Error code.
     116 */
     117static inline int usb_device_control_read(usb_device_connection_t *instance,
    87118    usb_endpoint_t ep, uint64_t setup, void *data, size_t size, size_t *rsize)
    88119{
    89         assert(conn);
    90         return usb_hc_read(conn->hc_connection,
    91             conn->address, ep, setup, data, size, rsize);
     120        assert(instance);
     121        return usb_hc_read(instance->hc_connection,
     122            instance->address, ep, setup, data, size, rsize);
    92123}
    93124/*----------------------------------------------------------------------------*/
    94 static inline int usb_device_control_write(usb_device_connection_t *conn,
     125/** Send data to the device.
     126 * @param instance device connection structure to use.
     127 * @param ep target endpoint's number.
     128 * @param setup Setup stage data (control transfers).
     129 * @param data data buffer.
     130 * @param size size of the data buffer.
     131 * @return Error code.
     132 */
     133static inline int usb_device_control_write(usb_device_connection_t *instance,
    95134    usb_endpoint_t ep, uint64_t setup, const void *data, size_t size)
    96135{
    97         assert(conn);
    98         return usb_hc_write(conn->hc_connection,
    99             conn->address, ep, setup, data, size);
     136        assert(instance);
     137        return usb_hc_write(instance->hc_connection,
     138            instance->address, ep, setup, data, size);
    100139}
    101140/*----------------------------------------------------------------------------*/
    102141/** Wrapper for read calls with no setup stage.
    103  * @param[in] connection hc connection to use.
     142 * @param[in] instance device connection structure.
    104143 * @param[in] address USB device address.
    105144 * @param[in] endpoint USB device endpoint.
    … …  
    109148 * @return Error code.
    110149 */
    111 static inline int usb_device_read(usb_device_connection_t *conn,
     150static inline int usb_device_read(usb_device_connection_t *instance,
    112151    usb_endpoint_t ep, void *data, size_t size, size_t *real_size)
    113152{
    114         return usb_device_control_read(conn, ep, 0, data, size, real_size);
     153        return usb_device_control_read(instance, ep, 0, data, size, real_size);
    115154}
    116155/*----------------------------------------------------------------------------*/
    117156/** Wrapper for write calls with no setup stage.
    118  * @param connection hc connection to use.
     157 * @param instance device connection structure.
    119158 * @param address USB device address.
    120159 * @param endpoint USB device endpoint.
    … …  
    123162 * @return Error code.
    124163 */
    125 static inline int usb_device_write(usb_device_connection_t *conn,
     164static inline int usb_device_write(usb_device_connection_t *instance,
    126165    usb_endpoint_t ep, const void *data, size_t size)
    127166{
    128         return usb_device_control_write(conn, ep, 0, data, size);
     167        return usb_device_control_write(instance, ep, 0, data, size);
    129168}
    130169#endif
Note: See TracChangeset for help on using the changeset viewer.