sysadmin/ipxe
1
0
Fork 0
mirror of https://github.com/ipxe/ipxe synced 2025-12-23 13:30:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

[usb] Add generic USB human interface device (HID) framework

Browse Source 
Signed-off-by: Michael Brown <mcb30@ipxe.org>
This commit is contained in:
Michael Brown
2015-05-11 14:57:28 +01:00
parent 0eaa3a34bf
commit a8e4187c45
3 changed files with 258 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/include/ipxe/errfile.h
View File

@@ -81,6 +81,7 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#define ERRFILE_xhci ( ERRFILE_DRIVER | 0x00090000 )
#define ERRFILE_ehci ( ERRFILE_DRIVER | 0x000a0000 )
#define ERRFILE_uhci ( ERRFILE_DRIVER | 0x000b0000 )
#define ERRFILE_usbhid ( ERRFILE_DRIVER | 0x000c0000 )
#define ERRFILE_nvs ( ERRFILE_DRIVER | 0x00100000 )
#define ERRFILE_spi ( ERRFILE_DRIVER | 0x00110000 )

106
src/include/ipxe/usbhid.h Normal file
View File

@@ -0,0 +1,106 @@
#ifndef _IPXE_USBHID_H
#define _IPXE_USBHID_H
/** @file
*
* USB human interface devices (HID)
*
*/
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#include <ipxe/usb.h>
/** Class code for human interface devices */
#define USB_CLASS_HID 3
/** Subclass code for boot devices */
#define USB_SUBCLASS_HID_BOOT 1
/** Set protocol */
#define USBHID_SET_PROTOCOL \
( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE | \
USB_REQUEST_TYPE ( 0x0b ) )
/** Boot protocol */
#define USBHID_PROTOCOL_BOOT 0
/** Report protocol */
#define USBHID_PROTOCOL_REPORT 1
/** Set idle time */
#define USBHID_SET_IDLE \
( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE | \
USB_REQUEST_TYPE ( 0x0a ) )
/** A USB human interface device */
struct usb_hid {
/** USB function */
struct usb_function *func;
/** Interrupt IN endpoint */
struct usb_endpoint in;
/** Interrupt OUT endpoint (optional) */
struct usb_endpoint out;
};
/**
* Initialise USB human interface device
*
* @v hid USB human interface device
* @v func USB function
* @v in Interrupt IN endpoint operations
* @v out Interrupt OUT endpoint operations (or NULL)
*/
static inline __attribute__ (( always_inline )) void
usbhid_init ( struct usb_hid *hid, struct usb_function *func,
struct usb_endpoint_driver_operations *in,
struct usb_endpoint_driver_operations *out ) {
struct usb_device *usb = func->usb;
hid->func = func;
usb_endpoint_init ( &hid->in, usb, in );
if ( out )
usb_endpoint_init ( &hid->out, usb, out );
}
/**
* Set protocol
*
* @v usb USB device
* @v interface Interface number
* @v protocol HID protocol
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usbhid_set_protocol ( struct usb_device *usb, unsigned int interface,
unsigned int protocol ) {
return usb_control ( usb, USBHID_SET_PROTOCOL, protocol, interface,
NULL, 0 );
}
/**
* Set idle time
*
* @v usb USB device
* @v interface Interface number
* @v report Report ID
* @v duration Duration (in 4ms units)
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline )) int
usbhid_set_idle ( struct usb_device *usb, unsigned int interface,
unsigned int report, unsigned int duration ) {
return usb_control ( usb, USBHID_SET_IDLE,
( ( duration << 8 ) | report ),
interface, NULL, 0 );
}
extern int usbhid_open ( struct usb_hid *hid );
extern void usbhid_close ( struct usb_hid *hid );
extern int usbhid_refill ( struct usb_hid *hid );
extern int usbhid_describe ( struct usb_hid *hid,
struct usb_configuration_descriptor *config );
#endif /* _IPXE_USBHID_H */