Changeset e56b8a3 in mainline for uspace/lib/drv/include/usbhid_iface.h

Timestamp:

2011-05-27T13:27:22Z (13 years ago)

Author:

Matej Klonfar <maklf@…>

Branches:

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

Children:

0c904a3

Parents:

8242dd86 (diff), 567a3e2 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Development changes

File:

• uspace/lib/drv/include/usbhid_iface.h (modified) (4 diffs)

uspace/lib/drv/include/usbhid_iface.h

@@ -45 +45 @@
          * Parameters: none
          * Answer:
-         * - EOK (expected always as long as device support USB HID interface)
-         * Parameters of the answer:
-         * - number of items
+         * - Size of one report in bytes.
          */
         IPC_M_USBHID_GET_EVENT_LENGTH,
@@ -63 +61 @@
          * It is okay if the client requests less data. Extra data must
          * be truncated by the driver.
+         *
+         * @todo Change this comment.
          */
-        IPC_M_USBHID_GET_EVENT
+        IPC_M_USBHID_GET_EVENT,
+        
+        /** Get the size of the report descriptor from the HID device.
+         *
+         * Parameters:
+         * - none
+         * Answer:
+         * - EOK - method is implemented (expected always)
+         * Parameters of the answer:
+         * - Size of the report in bytes.
+         */
+        IPC_M_USBHID_GET_REPORT_DESCRIPTOR_LENGTH,
+        
+        /** Get the report descriptor from the HID device.
+         *
+         * Parameters:
+         * - none
+         * The call is followed by data read expecting the descriptor itself.
+         * Answer:
+         * - EOK - report descriptor returned.
+         */
+        IPC_M_USBHID_GET_REPORT_DESCRIPTOR
 } usbhid_iface_funcs_t;
 
@@ -75 +96 @@
          *
          * @param[in] fun DDF function answering the request.
-         * @return Number of events or error code.
+         * @return Size of the event in bytes.
          */
         size_t (*get_event_length)(ddf_fun_t *fun);
@@ -87 +108 @@
          * @return Error code.
          */
-        int (*get_event)(ddf_fun_t *fun, int32_t *buffer, size_t size,
-            size_t *act_size, unsigned int flags);
+        int (*get_event)(ddf_fun_t *fun, uint8_t *buffer, size_t size,
+            size_t *act_size, int *event_nr, unsigned int flags);
+        
+        /** Get size of the report descriptor in bytes.
+         *
+         * @param[in] fun DDF function answering the request.
+         * @return Size of the report descriptor in bytes.
+         */
+        size_t (*get_report_descriptor_length)(ddf_fun_t *fun);
+        
+        /** Get the report descriptor from the HID device.
+         *
+         * @param[in] fun DDF function answering the request.
+         * @param[out] desc Buffer with the report descriptor.
+         * @param[in] size Size of the allocated @p desc buffer.
+         * @param[out] act_size Actual size of the report descriptor returned.
+         * @return Error code.
+         */
+        int (*get_report_descriptor)(ddf_fun_t *fun, uint8_t *desc, 
+            size_t size, size_t *act_size);
 } usbhid_iface_t;