usbhid.h File Reference

USB human interface devices (HID) More...

#include <ipxe/usb.h>

Go to the source code of this file.

Data Structures
struct	usb_hid
	A USB human interface device. More...

Macros
#define	USB_CLASS_HID   3
	Class code for human interface devices. More...
#define	USB_SUBCLASS_HID_BOOT   1
	Subclass code for boot devices. More...
#define	USBHID_SET_PROTOCOL
	Set protocol. More...
#define	USBHID_PROTOCOL_BOOT   0
	Boot protocol. More...
#define	USBHID_PROTOCOL_REPORT   1
	Report protocol. More...
#define	USBHID_SET_IDLE
	Set idle time. More...
#define	USBHID_SET_REPORT
	Set report. More...
#define	USBHID_REPORT_INPUT   0x01
	Input report type. More...
#define	USBHID_REPORT_OUTPUT   0x02
	Output report type. More...
#define	USBHID_REPORT_FEATURE   0x03
	Feature report type. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static void	usbhid_init (struct usb_hid *hid, struct usb_function *func, struct usb_endpoint_driver_operations *in, struct usb_endpoint_driver_operations *out)
	Initialise USB human interface device. More...
static int	usbhid_set_protocol (struct usb_device *usb, unsigned int interface, unsigned int protocol)
	Set protocol. More...
static int	usbhid_set_idle (struct usb_device *usb, unsigned int interface, unsigned int report, unsigned int duration)
	Set idle time. More...
static int	usbhid_set_report (struct usb_device *usb, unsigned int interface, unsigned int type, unsigned int report, void *data, size_t len)
	Set report. More...
int	usbhid_open (struct usb_hid *hid)
	Open USB human interface device. More...
void	usbhid_close (struct usb_hid *hid)
	Close USB human interface device. More...
int	usbhid_refill (struct usb_hid *hid)
	Refill USB human interface device endpoints. More...
int	usbhid_describe (struct usb_hid *hid, struct usb_configuration_descriptor *config)
	Describe USB human interface device. More...

Detailed Description

USB human interface devices (HID)

Definition in file usbhid.h.

Macro Definition Documentation

USB_CLASS_HID

#define USB_CLASS_HID   3

Class code for human interface devices.

Definition at line 15 of file usbhid.h.

USB_SUBCLASS_HID_BOOT

#define USB_SUBCLASS_HID_BOOT   1

Subclass code for boot devices.

Definition at line 18 of file usbhid.h.

USBHID_SET_PROTOCOL

#define USBHID_SET_PROTOCOL

Value:

( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE |          \
          USB_REQUEST_TYPE ( 0x0b ) )

Set protocol.

Definition at line 21 of file usbhid.h.

USBHID_PROTOCOL_BOOT

#define USBHID_PROTOCOL_BOOT   0

Boot protocol.

Definition at line 26 of file usbhid.h.

USBHID_PROTOCOL_REPORT

#define USBHID_PROTOCOL_REPORT   1

Report protocol.

Definition at line 29 of file usbhid.h.

USBHID_SET_IDLE

#define USBHID_SET_IDLE

Value:

( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE |          \
          USB_REQUEST_TYPE ( 0x0a ) )

Set idle time.

Definition at line 32 of file usbhid.h.

USBHID_SET_REPORT

#define USBHID_SET_REPORT

Value:

( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE |          \
          USB_REQUEST_TYPE ( 0x09 ) )

Set report.

Definition at line 37 of file usbhid.h.

USBHID_REPORT_INPUT

#define USBHID_REPORT_INPUT   0x01

Input report type.

Definition at line 42 of file usbhid.h.

USBHID_REPORT_OUTPUT

#define USBHID_REPORT_OUTPUT   0x02

Output report type.

Definition at line 45 of file usbhid.h.

USBHID_REPORT_FEATURE

#define USBHID_REPORT_FEATURE   0x03

Feature report type.

Definition at line 48 of file usbhid.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

usbhid_init()

static void usbhid_init ( struct usb_hid *  hid, struct usb_function *  func, struct usb_endpoint_driver_operations *  in, struct usb_endpoint_driver_operations *  out  )

inlinestatic

Initialise USB human interface device.

Parameters

hid	USB human interface device
func	USB function
in	Interrupt IN endpoint operations
out	Interrupt OUT endpoint operations (or NULL)

Definition at line 69 of file usbhid.h.

                                                           {
        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 );
}

References usb_hid::func, in, usb_hid::in, out, usb_hid::out, usb_function::usb, and usb_endpoint_init().

Referenced by usbkbd_probe().

usbhid_set_protocol()

static int usbhid_set_protocol ( struct usb_device *  usb, unsigned int  interface, unsigned int  protocol  )

inlinestatic

Set protocol.

Parameters

usb	USB device
interface	Interface number
protocol	HID protocol

Return values

rc	Return status code

Definition at line 89 of file usbhid.h.

                                              {

        return usb_control ( usb, USBHID_SET_PROTOCOL, protocol, interface,
                             NULL, 0 );
}

References NULL, protocol, usb_control(), and USBHID_SET_PROTOCOL.

Referenced by usbkbd_probe().

usbhid_set_idle()

static int usbhid_set_idle ( struct usb_device *  usb, unsigned int  interface, unsigned int  report, unsigned int  duration  )

inlinestatic

Set idle time.

Parameters

usb	USB device
interface	Interface number
report	Report ID
duration	Duration (in 4ms units)

Return values

rc	Return status code

Definition at line 106 of file usbhid.h.

                                                               {

        return usb_control ( usb, USBHID_SET_IDLE,
                             ( ( duration << 8 ) | report ),
                             interface, NULL, 0 );
}

References duration, NULL, usb_control(), and USBHID_SET_IDLE.

Referenced by usbkbd_probe().

usbhid_set_report()

static int usbhid_set_report ( struct usb_device *  usb, unsigned int  interface, unsigned int  type, unsigned int  report, void *  data, size_t  len  )

inlinestatic

Set report.

Parameters

usb	USB device
interface	Interface number
type	Report type
report	Report ID
data	Report data
len	Length of report data

Return values

rc	Return status code

Definition at line 126 of file usbhid.h.

                                 {

        return usb_control ( usb, USBHID_SET_REPORT, ( ( type << 8 ) | report ),
                             interface, data, len );
}

References data, len, type, usb_control(), and USBHID_SET_REPORT.

Referenced by usbkbd_set_leds().

usbhid_open()

int usbhid_open

(

struct usb_hid *

hid

)

Open USB human interface device.

Parameters

hid	USB human interface device

Return values

rc	Return status code

Definition at line 43 of file usbhid.c.

                                        {
        int rc;

        /* Open interrupt IN endpoint */
        if ( ( rc = usb_endpoint_open ( &hid->in ) ) != 0 ) {
                DBGC ( hid, "HID %s could not open interrupt IN: %s\n",
                       hid->func->name, strerror ( rc ) );
                goto err_open_in;
        }

        /* Refill interrupt IN endpoint */
        if ( ( rc = usb_refill ( &hid->in ) ) != 0 ) {
                DBGC ( hid, "HID %s could not refill interrupt IN: %s\n",
                       hid->func->name, strerror ( rc ) );
                goto err_refill_in;
        }

        /* Open interrupt OUT endpoint, if applicable */
        if ( hid->out.usb &&
             ( ( rc = usb_endpoint_open ( &hid->out ) ) != 0 ) ) {
                DBGC ( hid, "HID %s could not open interrupt OUT: %s\n",
                       hid->func->name, strerror ( rc ) );
                goto err_open_out;
        }

        return 0;

        usb_endpoint_close ( &hid->out );
 err_open_out:
 err_refill_in:
        usb_endpoint_close ( &hid->in );
 err_open_in:
        return rc;
}

References DBGC, usb_hid::func, usb_hid::in, usb_function::name, usb_hid::out, rc, strerror(), usb_endpoint::usb, usb_endpoint_close(), usb_endpoint_open(), and usb_refill().

Referenced by usbkbd_probe().

usbhid_close()

void usbhid_close

(

struct usb_hid *

hid

)

Close USB human interface device.

Parameters

hid	USB human interface device

Definition at line 83 of file usbhid.c.

                                          {

        /* Close interrupt OUT endpoint, if applicable */
        if ( hid->out.usb )
                usb_endpoint_close ( &hid->out );

        /* Close interrupt IN endpoint */
        usb_endpoint_close ( &hid->in );
}

References usb_hid::in, usb_hid::out, usb_endpoint::usb, and usb_endpoint_close().

Referenced by usbkbd_probe(), and usbkbd_remove().

usbhid_refill()

int usbhid_refill

(

struct usb_hid *

hid

)

Refill USB human interface device endpoints.

Parameters

hid	USB human interface device

Return values

rc	Return status code

Definition at line 99 of file usbhid.c.

                                          {
        int rc;

        /* Refill interrupt IN endpoint */
        if ( ( rc = usb_refill ( &hid->in ) ) != 0 )
                return rc;

        /* Refill interrupt OUT endpoint, if applicable */
        if ( hid->out.usb && ( ( rc = usb_refill ( &hid->out ) ) != 0 ) )
                return rc;

        return 0;
}

References usb_hid::in, usb_hid::out, rc, usb_endpoint::usb, and usb_refill().

usbhid_describe()

int usbhid_describe	(	struct usb_hid *	hid,
		struct usb_configuration_descriptor *	config
	)

Describe USB human interface device.

Parameters

hid	USB human interface device
config	Configuration descriptor

Return values

rc	Return status code

Definition at line 120 of file usbhid.c.

                                                                    {
        struct usb_interface_descriptor *desc;
        int rc;

        /* Locate interface descriptor */
        desc = usb_interface_descriptor ( config, hid->func->interface[0], 0 );
        if ( ! desc ) {
                DBGC ( hid, "HID %s has no interface descriptor\n",
                       hid->func->name );
                return -EINVAL;
        }

        /* Describe interrupt IN endpoint */
        if ( ( rc = usb_endpoint_described ( &hid->in, config, desc,
                                             USB_INTERRUPT_IN, 0 ) ) != 0 ) {
                DBGC ( hid, "HID %s could not describe interrupt IN: %s\n",
                       hid->func->name, strerror ( rc ) );
                return rc;
        }

        /* Describe interrupt OUT endpoint, if applicable */
        if ( hid->out.usb &&
             ( ( rc = usb_endpoint_described ( &hid->out, config, desc,
                                               USB_INTERRUPT_OUT, 0 ) ) != 0 )){
                DBGC ( hid, "HID %s could not describe interrupt OUT: %s\n",
                       hid->func->name, strerror ( rc ) );
                return rc;
        }

        return 0;
}

References DBGC, EINVAL, usb_hid::func, usb_hid::in, usb_function::interface, usb_function::name, usb_hid::out, rc, strerror(), usb_endpoint::usb, usb_endpoint_described(), usb_interface_descriptor(), USB_INTERRUPT_IN, and USB_INTERRUPT_OUT.

Referenced by usbkbd_probe().