Changeset bc1c6fb in mainline

Timestamp:

2011-03-08T15:06:52Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

67f54965, a8e98498

Parents:

e2b58a63

Message:

Doxygen comments fixes

No change in functionality.

Location:

uspace

Files:

• drv/usbmid/usbmid.c (modified) (1 diff)
• drv/usbmouse/init.c (modified) (1 diff)
• drv/vhc/conndev.c (modified) (1 diff)
• lib/usb/src/ddfiface.c (modified) (5 diffs)
• lib/usb/src/hub.c (modified) (3 diffs)
• lib/usb/src/pipes.c (modified) (1 diff)
• lib/usb/src/recognise.c (modified) (2 diffs)
• lib/usb/src/request.c (modified) (2 diffs)

uspace/drv/usbmid/usbmid.c

@@ -125 +125 @@
 /** Create new interface for USB MID device.
  *
- * @param dev Backing generic DDF child device (representing interface).
+ * @param fun Backing generic DDF device function (representing interface).
  * @param iface_no Interface number.
  * @return New interface.

uspace/drv/usbmouse/init.c

@@ -108 +108 @@
 /** Default handler for IPC methods not handled by DDF.
  *
- * @param dev Device handling the call.
+ * @param fun Device function handling the call.
  * @param icallid Call id.
  * @param icall Call data.

uspace/drv/vhc/conndev.c

@@ -110 +110 @@
 /** Callback for DDF when client disconnects.
  *
- * @param d Device the client was connected to.
+ * @param fun Device function the client was connected to.
  */
 void on_client_close(ddf_fun_t *fun)

uspace/lib/usb/src/ddfiface.c

@@ -56 +56 @@
 /** Get host controller handle, interface implementation for hub driver.
  *
- * @param[in] device Device the operation is running on.
+ * @param[in] fun Device function the operation is running on.
  * @param[out] handle Storage for the host controller handle.
  * @return Error code.
@@ -69 +69 @@
  * a hub driver.
  *
- * @param[in] device Device the operation is running on.
+ * @param[in] fun Device function the operation is running on.
  * @param[out] handle Storage for the host controller handle.
  * @return Error code.
@@ -101 +101 @@
 /** Get host controller handle, interface implementation for HC driver.
  *
- * @param[in] device Device the operation is running on.
+ * @param[in] fun Device function the operation is running on.
  * @param[out] handle Storage for the host controller handle.
  * @return Always EOK.
@@ -118 +118 @@
 /** Get USB device address, interface implementation for hub driver.
  *
- * @param[in] device Device the operation is running on.
+ * @param[in] fun Device function the operation is running on.
  * @param[in] handle Devman handle of USB device we want address of.
  * @param[out] address Storage for USB address of device with handle @p handle.
@@ -153 +153 @@
  * a hub driver.
  *
- * @param[in] device Device the operation is running on.
+ * @param[in] fun Device function the operation is running on.
  * @param[in] handle Devman handle of USB device we want address of.
  * @param[out] address Storage for USB address of device with handle @p handle.

uspace/lib/usb/src/hub.c

@@ -57 +57 @@
  *
  * @param connection Opened connection to host controller.
+ * @param speed Speed of the device that will respond on the default address.
  * @return Error code.
  */
@@ -86 +87 @@
  *
  * @param connection Opened connection to host controller.
+ * @param speed Speed of the new device (device that will be assigned
+ *    the returned address).
  * @return Assigned USB address or negative error code.
  */
@@ -156 +159 @@
  * error codes than those listed as return codes by this function itself).
  *
- * @param parent Parent device (i.e. the hub device).
- * @param connection Opened connection to host controller.
- * @param dev_speed New device speed.
- * @param enable_port Function for enabling signaling through the port the
+ * @param[in] parent Parent device (i.e. the hub device).
+ * @param[in] connection Opened connection to host controller.
+ * @param[in] dev_speed New device speed.
+ * @param[in] enable_port Function for enabling signaling through the port the
  *      device is attached to.
- * @param port_no Port number (passed through to @p enable_port).
- * @param arg Any data argument to @p enable_port.
+ * @param[in] port_no Port number (passed through to @p enable_port).
+ * @param[in] arg Any data argument to @p enable_port.
  * @param[out] assigned_address USB address of the device.
  * @param[out] assigned_handle Devman handle of the new device.
+ * @param[in] dev_ops Child device ops.
+ * @param[in] new_dev_data Arbitrary pointer to be stored in the child
+ *      as @c driver_data.
+ * @param[out] new_fun Storage where pointer to allocated child function
+ *      will be written.
  * @return Error code.
  * @retval ENOENT Connection to HC not opened.

uspace/lib/usb/src/pipes.c

@@ -99 +99 @@
  *
  * @param connection Connection structure to be initialized.
- * @param device Generic device backing the USB device.
+ * @param dev Generic device backing the USB device.
  * @return Error code.
  */

uspace/lib/usb/src/recognise.c

@@ -138 +138 @@
 /** Create device match ids based on its interface.
  *
- * @param[in] descriptor Interface descriptor.
+ * @param[in] desc_device Device descriptor.
+ * @param[in] desc_interface Interface descriptor.
  * @param[out] matches Initialized list of match ids.
  * @return Error code (the two mentioned are not the only ones).
  * @retval EINVAL Invalid input parameters (expects non NULL pointers).
- * @retval ENOENT Interface does not specify class.
+ * @retval ENOENT Device class is not "use interface".
  */
 int usb_device_create_match_ids_from_interface(
@@ -333 +334 @@
  * @param[in] parent Parent device.
  * @param[out] child_handle Handle of the child device.
+ * @param[in] dev_ops Child device ops.
+ * @param[in] dev_data Arbitrary pointer to be stored in the child
+ *      as @c driver_data.
+ * @param[out] child_fun Storage where pointer to allocated child function
+ *      will be written.
  * @return Error code.
  */

uspace/lib/usb/src/request.c

@@ -195 +195 @@
  * @param[in] pipe Control endpoint pipe (session must be already started).
  * @param[in] request_type Request type (standard/class/vendor).
+ * @param[in] recipient Request recipient (device/interface/endpoint).
  * @param[in] descriptor_type Descriptor type (device/configuration/HID/...).
  * @param[in] descriptor_index Descriptor index.
@@ -229 +230 @@
  * @param[in] pipe Control endpoint pipe (session must be already started).
  * @param[in] request_type Request type (standard/class/vendor).
+ * @param[in] recipient Request recipient (device/interface/endpoint).
  * @param[in] descriptor_type Descriptor type (device/configuration/HID/...).
  * @param[in] descriptor_index Descriptor index.