iPXE
usbhid.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <string.h>
27 #include <errno.h>
28 #include <ipxe/usb.h>
29 #include <ipxe/usbhid.h>
30 
31 /** @file
32  *
33  * USB human interface devices (HID)
34  *
35  */
36 
37 /**
38  * Open USB human interface device
39  *
40  * @v hid USB human interface device
41  * @ret rc Return status code
42  */
43 int usbhid_open ( struct usb_hid *hid ) {
44  int rc;
45 
46  /* Open interrupt IN endpoint */
47  if ( ( rc = usb_endpoint_open ( &hid->in ) ) != 0 ) {
48  DBGC ( hid, "HID %s could not open interrupt IN: %s\n",
49  hid->func->name, strerror ( rc ) );
50  goto err_open_in;
51  }
52 
53  /* Refill interrupt IN endpoint */
54  if ( ( rc = usb_refill ( &hid->in ) ) != 0 ) {
55  DBGC ( hid, "HID %s could not refill interrupt IN: %s\n",
56  hid->func->name, strerror ( rc ) );
57  goto err_refill_in;
58  }
59 
60  /* Open interrupt OUT endpoint, if applicable */
61  if ( hid->out.usb &&
62  ( ( rc = usb_endpoint_open ( &hid->out ) ) != 0 ) ) {
63  DBGC ( hid, "HID %s could not open interrupt OUT: %s\n",
64  hid->func->name, strerror ( rc ) );
65  goto err_open_out;
66  }
67 
68  return 0;
69 
70  usb_endpoint_close ( &hid->out );
71  err_open_out:
72  err_refill_in:
73  usb_endpoint_close ( &hid->in );
74  err_open_in:
75  return rc;
76 }
77 
78 /**
79  * Close USB human interface device
80  *
81  * @v hid USB human interface device
82  */
83 void usbhid_close ( struct usb_hid *hid ) {
84 
85  /* Close interrupt OUT endpoint, if applicable */
86  if ( hid->out.usb )
87  usb_endpoint_close ( &hid->out );
88 
89  /* Close interrupt IN endpoint */
90  usb_endpoint_close ( &hid->in );
91 }
92 
93 /**
94  * Refill USB human interface device endpoints
95  *
96  * @v hid USB human interface device
97  * @ret rc Return status code
98  */
99 int usbhid_refill ( struct usb_hid *hid ) {
100  int rc;
101 
102  /* Refill interrupt IN endpoint */
103  if ( ( rc = usb_refill ( &hid->in ) ) != 0 )
104  return rc;
105 
106  /* Refill interrupt OUT endpoint, if applicable */
107  if ( hid->out.usb && ( ( rc = usb_refill ( &hid->out ) ) != 0 ) )
108  return rc;
109 
110  return 0;
111 }
112 
113 /**
114  * Describe USB human interface device
115  *
116  * @v hid USB human interface device
117  * @v config Configuration descriptor
118  * @ret rc Return status code
119  */
120 int usbhid_describe ( struct usb_hid *hid,
121  struct usb_configuration_descriptor *config ) {
122  struct usb_interface_descriptor *desc;
123  int rc;
124 
125  /* Locate interface descriptor */
126  desc = usb_interface_descriptor ( config, hid->func->interface[0], 0 );
127  if ( ! desc ) {
128  DBGC ( hid, "HID %s has no interface descriptor\n",
129  hid->func->name );
130  return -EINVAL;
131  }
132 
133  /* Describe interrupt IN endpoint */
134  if ( ( rc = usb_endpoint_described ( &hid->in, config, desc,
135  USB_INTERRUPT_IN, 0 ) ) != 0 ) {
136  DBGC ( hid, "HID %s could not describe interrupt IN: %s\n",
137  hid->func->name, strerror ( rc ) );
138  return rc;
139  }
140 
141  /* Describe interrupt OUT endpoint, if applicable */
142  if ( hid->out.usb &&
143  ( ( rc = usb_endpoint_described ( &hid->out, config, desc,
144  USB_INTERRUPT_OUT, 0 ) ) != 0 )){
145  DBGC ( hid, "HID %s could not describe interrupt OUT: %s\n",
146  hid->func->name, strerror ( rc ) );
147  return rc;
148  }
149 
150  return 0;
151 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
uint8_t interface[0]
List of interface numbers.
Definition: usb.h:680
const char * name
Name.
Definition: usb.h:659
Error codes.
struct usb_endpoint in
Interrupt IN endpoint.
Definition: usbhid.h:55
#define DBGC(...)
Definition: compiler.h:505
int usbhid_describe(struct usb_hid *hid, struct usb_configuration_descriptor *config)
Describe USB human interface device.
Definition: usbhid.c:120
int usb_endpoint_open(struct usb_endpoint *ep)
Open USB endpoint.
Definition: usb.c:293
#define USB_INTERRUPT_IN
Interrupt IN endpoint (internal) type.
Definition: usb.h:287
struct usb_endpoint out
Interrupt OUT endpoint (optional)
Definition: usbhid.h:57
void usb_endpoint_close(struct usb_endpoint *ep)
Close USB endpoint.
Definition: usb.c:370
int usb_endpoint_described(struct usb_endpoint *ep, struct usb_configuration_descriptor *config, struct usb_interface_descriptor *interface, unsigned int type, unsigned int index)
Describe USB endpoint from device configuration.
Definition: usb.c:241
int usbhid_refill(struct usb_hid *hid)
Refill USB human interface device endpoints.
Definition: usbhid.c:99
int usb_refill(struct usb_endpoint *ep)
Refill endpoint.
Definition: usb.c:642
void usbhid_close(struct usb_hid *hid)
Close USB human interface device.
Definition: usbhid.c:83
A USB interface descriptor.
Definition: usb.h:230
struct usb_interface_descriptor * usb_interface_descriptor(struct usb_configuration_descriptor *config, unsigned int interface, unsigned int alternate)
Locate USB interface descriptor.
Definition: usb.c:143
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
#define USB_INTERRUPT_OUT
Interrupt OUT endpoint (internal) type.
Definition: usb.h:290
A USB human interface device.
Definition: usbhid.h:51
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
A USB configuration descriptor.
Definition: usb.h:195
Universal Serial Bus (USB)
USB human interface devices (HID)
struct usb_device * usb
USB device.
Definition: usb.h:391
struct usb_function * func
USB function.
Definition: usbhid.h:53
String functions.
int usbhid_open(struct usb_hid *hid)
Open USB human interface device.
Definition: usbhid.c:43