summaryrefslogtreecommitdiffstats
path: root/src/drivers/usb/usbhid.c
blob: c74535a0571f10db45591ec4ba476a1980baee46 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * Copyright (C) 2015 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * You can also choose to distribute this program under the terms of
 * the Unmodified Binary Distribution Licence (as given in the file
 * COPYING.UBDL), provided that you have satisfied its requirements.
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

#include <string.h>
#include <errno.h>
#include <ipxe/usb.h>
#include <ipxe/usbhid.h>

/** @file
 *
 * USB human interface devices (HID)
 *
 */

/**
 * Open USB human interface device
 *
 * @v hid		USB human interface device
 * @ret rc		Return status code
 */
int usbhid_open ( struct usb_hid *hid ) {
	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;
}

/**
 * Close USB human interface device
 *
 * @v hid		USB human interface device
 */
void usbhid_close ( struct usb_hid *hid ) {

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

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

/**
 * Refill USB human interface device endpoints
 *
 * @v hid		USB human interface device
 * @ret rc		Return status code
 */
int usbhid_refill ( struct usb_hid *hid ) {
	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;
}

/**
 * Describe USB human interface device
 *
 * @v hid		USB human interface device
 * @v config		Configuration descriptor
 * @ret rc		Return status code
 */
int usbhid_describe ( struct usb_hid *hid,
		      struct usb_configuration_descriptor *config ) {
	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;
}