Subversion Repositories freemyipod

Rev

Rev 889 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
881 theseven 1
#include "global.h"
2
#include "protocol/usb/usb.h"
3
 
4
void usb_start_rx(const struct usb_instance* data, union usb_endpoint_number ep, void* buf, int size)
5
{
6
    data->driver->start_rx(data, ep, buf, size);
7
}
8
 
9
void usb_start_tx(const struct usb_instance* data, union usb_endpoint_number ep, const void* buf, int size)
10
{
11
    data->driver->start_tx(data, ep, buf, size);
12
}
13
 
14
void usb_set_stall(const struct usb_instance* data, union usb_endpoint_number ep, int stall)
15
{
16
    data->driver->set_stall(data, ep, stall);
17
}
18
 
19
void usb_ep0_start_rx(const struct usb_instance* data, int non_setup)
20
{
21
    data->driver->ep0_start_rx(data, non_setup);
22
}
23
 
24
void usb_ep0_start_tx(const struct usb_instance* data, const void* buf, int len)
25
{
26
    // Expect zero-length ACK if we are about to actually send data, otherwise expect SETUP.
27
    usb_ep0_start_rx(data, !!len);
28
 
29
    data->driver->ep0_start_tx(data, buf, len);
30
}
31
 
32
void usb_ep0_expect_setup(const struct usb_instance* data)
33
{
34
    // The next packet needs to be a SETUP, so lock out everything on the IN pipe.
35
    union usb_endpoint_number ep = { .number = 0, .direction = USB_ENDPOINT_DIRECTION_IN };
36
    usb_set_stall(data, ep, 1);
37
 
38
    // Set up the OUT pipe for the SETUP packet, STALLing everything else.
39
    usb_ep0_start_rx(data, 0);
40
}
41
 
42
void usb_unconfigure_ep(const struct usb_instance* data, union usb_endpoint_number ep)
43
{
44
    data->driver->unconfigure_ep(data, ep);
45
}
46
 
47
void usb_configure_ep(const struct usb_instance* data, union usb_endpoint_number ep, enum usb_endpoint_type type, int maxpacket)
48
{
49
    // Reset the endpoint, just in case someone left it in a dirty state.
50
    usb_unconfigure_ep(data, ep);
51
 
52
    // Write the new configuration for the endpoint.
53
    // This resets the data toggle to DATA0, as required by the USB specification.
54
    data->driver->configure_ep(data, ep, type, maxpacket);
55
}
56
 
57
int usb_get_max_transfer_size(const struct usb_instance* data, union usb_endpoint_number ep)
58
{
59
    return data->driver->get_max_transfer_size(data, ep);
60
}
61
 
62
static void usb_unconfigure(const struct usb_instance* data)
63
{
64
    // Notify a configuration and its active interface altsettings that it was just kicked out.
65
    int configid = data->state->current_configuration;
66
    if (!configid) return;
67
    const struct usb_configuration* configuration = data->configurations[configid - 1];
68
    int i;
69
    for (i = 0; i < configuration->interface_count; i++)
70
    {
71
        struct usb_interface* interface = configuration->interfaces[i];
72
        const struct usb_altsetting* altsetting = interface->altsettings[interface->current_altsetting];
73
        if (altsetting->unset_altsetting)
74
            altsetting->unset_altsetting(data, i, interface->current_altsetting);
75
    }
76
    if (configuration->unset_configuration)
77
        configuration->unset_configuration(data, configid);
78
    data->state->current_configuration = 0;
79
}
80
 
81
static const struct usb_endpoint* usb_find_endpoint(const struct usb_instance* data,
82
                                                    union usb_endpoint_number ep, int* ifidx, int* epidx)
83
{
84
    // Figure out who's currently owning a (hardware) endpoint.
85
    // Returns a pointer to the usb_endpoint struct, and sets *epidx to its index within its altsetting.
86
    // *ifidx will be set to the interface number within the current configuration that the altsetting belongs to.
87
    // If nobody currently owns the specified endpoint, return NULL (*epidx and *ifidx will contain garbage).
88
    int configid = data->state->current_configuration;
89
    if (!configid) return NULL;
90
    const struct usb_configuration* configuration = data->configurations[configid - 1];
91
    for (*ifidx = 0; *ifidx < configuration->interface_count; (*ifidx)++)
92
    {
93
        const struct usb_interface* interface = configuration->interfaces[*ifidx];
94
        const struct usb_altsetting* altsetting = interface->altsettings[interface->current_altsetting];
95
        for (*epidx = 0; *epidx < altsetting->endpoint_count; (*epidx)++)
96
        {
97
            const struct usb_endpoint* endpoint = altsetting->endpoints[*epidx];
98
            if (endpoint->number.byte == ep.byte) return endpoint;
99
        }
100
    }
101
    return NULL;
102
}
103
 
104
static void usb_handle_ep0_setup(const struct usb_instance* data, union usb_ep0_buffer* buffer)
105
{
106
    // size < -2: do nothing at all (dangerous, you need to take care of priming EP0 yourself!)
107
    // size == -2: send STALL
108
    // size == -1: try to run default handler, or send STALL if none exists
109
    // size == 0: send ACK
110
    // size > 0: send <size> bytes at <addr>, then expect ACK
111
    const void* addr = NULL;
112
    int size = -1;
113
    switch (buffer->setup.bmRequestType.recipient)
114
    {
115
    case USB_SETUP_BMREQUESTTYPE_RECIPIENT_DEVICE:
116
        if (data->ctrl_request) size = data->ctrl_request(data, buffer, &addr);
117
        if (size != -1) break;
118
        switch (buffer->setup.bmRequestType.type)
119
        {
120
        case USB_SETUP_BMREQUESTTYPE_TYPE_STANDARD:
121
            switch (buffer->setup.bRequest.req)
122
            {
123
            case USB_SETUP_BREQUEST_GET_STATUS:
124
                if (buffer->setup.wLength != 2 || buffer->setup.wIndex
125
                 || !data->state->current_address || buffer->setup.wValue) break;
126
                data->buffer->raw[0] = 0;
127
                data->buffer->raw[1] = 1;
128
                addr = data->buffer;
129
                size = 2;
130
                break;
131
            case USB_SETUP_BREQUEST_SET_ADDRESS:
132
                if (buffer->setup.wLength || buffer->setup.wIndex || buffer->setup.wValue > 127) break;
133
                data->state->current_address = buffer->setup.wValue;
134
                // We can already set the address here, the driver has to take care to send the ACK with the old address.
135
                data->driver->set_address(data, data->state->current_address);
136
                size = 0;
137
                break;
138
            case USB_SETUP_BREQUEST_GET_DESCRIPTOR:
139
                if (!buffer->setup.wLength) break;
140
                switch (buffer->setup.wValue >> 8)
141
                {
142
                case USB_DESCRIPTOR_TYPE_DEVICE:
143
                    if ((buffer->setup.wValue & 0xff) || buffer->setup.wIndex) break;
144
                    addr = data->devicedescriptor;
145
                    size = data->devicedescriptor->bLength;
146
                    break;
147
                case USB_DESCRIPTOR_TYPE_CONFIGURATION:
148
                    if (buffer->setup.wIndex
149
                     || (buffer->setup.wValue & 0xff) >= data->configuration_count) break;
150
                    addr = data->configurations[buffer->setup.wValue & 0xff]->descriptor;
151
                    size = data->configurations[buffer->setup.wValue & 0xff]->descriptor->wTotalLength;
152
                    break;
153
                case USB_DESCRIPTOR_TYPE_STRING:
154
                    if ((buffer->setup.wValue & 0xff) > data->stringdescriptor_count) break;
155
                    addr = data->stringdescriptors[buffer->setup.wValue & 0xff];
156
                    size = data->stringdescriptors[buffer->setup.wValue & 0xff]->bLength;
157
                    break;
158
                }
159
                if (size > buffer->setup.wLength) size = buffer->setup.wLength;
160
                break;
161
            case USB_SETUP_BREQUEST_GET_CONFIGURATION:
162
                if (buffer->setup.wLength != 1 || buffer->setup.wIndex
163
                 || !data->state->current_address || buffer->setup.wValue) break;
164
                data->buffer->raw[0] = data->state->current_configuration;
165
                addr = data->buffer;
166
                size = 1;
167
                break;
168
            case USB_SETUP_BREQUEST_SET_CONFIGURATION:
169
                if (buffer->setup.wLength || buffer->setup.wIndex || !data->state->current_address
170
                 || buffer->setup.wValue > data->configuration_count) break;
171
                usb_unconfigure(data);
172
                data->state->current_configuration = buffer->setup.wValue;
173
                if (data->state->current_configuration)
174
                {
175
                    // Notify the configuration and its interface default altsettings that it should set up stuff
176
                    int configid = data->state->current_configuration;
177
                    const struct usb_configuration* configuration = data->configurations[configid - 1];
178
                    if (configuration->set_configuration)
179
                        configuration->set_configuration(data, configid);
180
                    int i;
181
                    for (i = 0; i < configuration->interface_count; i++)
182
                    {
183
                        struct usb_interface* interface = configuration->interfaces[i];
184
                        interface->current_altsetting = 0;
185
                        const struct usb_altsetting* altsetting = interface->altsettings[0];
186
                        if (altsetting->set_altsetting) altsetting->set_altsetting(data, i, 0);
187
                    }
188
                }
189
                size = 0;
190
                break;
191
            default: break;
192
            }
193
            break;
194
        }
195
        break;
196
    case USB_SETUP_BMREQUESTTYPE_RECIPIENT_INTERFACE:
197
    {
198
        if (!data->state->current_configuration) break;
199
        int configid = data->state->current_configuration;
200
        const struct usb_configuration* configuration = data->configurations[configid - 1];
201
        if (buffer->setup.wIndex >= configuration->interface_count) break;
202
        int intfid = buffer->setup.wIndex;
203
        struct usb_interface* interface = configuration->interfaces[intfid];
204
        if (interface->ctrl_request) size = interface->ctrl_request(data, intfid, buffer, &addr);
205
        if (size != -1) break;
206
        switch (buffer->setup.bmRequestType.type)
207
        {
208
        case USB_SETUP_BMREQUESTTYPE_TYPE_STANDARD:
209
            switch (buffer->setup.bRequest.req)
210
            {
211
            case USB_SETUP_BREQUEST_GET_STATUS:
212
                if (buffer->setup.wLength != 2 || buffer->setup.wValue) break;
213
                data->buffer->raw[0] = 0;
214
                data->buffer->raw[1] = 0;
215
                addr = data->buffer;
216
                size = 2;
217
                break;
218
            case USB_SETUP_BREQUEST_GET_INTERFACE:
219
                if (buffer->setup.wLength != 1 || buffer->setup.wValue) break;
220
                data->buffer->raw[0] = interface->current_altsetting;
221
                addr = data->buffer;
222
                size = 1;
223
                break;
224
            case USB_SETUP_BREQUEST_SET_INTERFACE:
225
            {
226
                if (buffer->setup.wLength
227
                 || buffer->setup.wValue > interface->altsetting_count) break;
228
                const struct usb_altsetting* altsetting = interface->altsettings[interface->current_altsetting];
229
                if (altsetting->unset_altsetting)
230
                    altsetting->unset_altsetting(data, intfid, interface->current_altsetting);
231
                interface->current_altsetting = buffer->setup.wValue;
232
                altsetting = interface->altsettings[interface->current_altsetting];
233
                if (altsetting->set_altsetting)
234
                    altsetting->set_altsetting(data, intfid, interface->current_altsetting);
235
                break;
236
            }
237
            default: break;
238
            }
239
            break;
240
            default: break;
241
        }
242
        break;
243
        case USB_SETUP_BMREQUESTTYPE_RECIPIENT_ENDPOINT:
244
        {
245
            if (!data->state->current_configuration) break;
246
            union usb_endpoint_number ep = { .byte = buffer->setup.wIndex };
247
            int intfid;
248
            int epid;
249
            const struct usb_endpoint* endpoint = usb_find_endpoint(data, ep, &intfid, &epid);
250
            if (!endpoint) break;
251
            if (endpoint->ctrl_request) size = endpoint->ctrl_request(data, intfid, epid, buffer, &addr);
252
            if (size != -1) break;
253
            switch (buffer->setup.bmRequestType.type)
254
            {
255
            case USB_SETUP_BMREQUESTTYPE_TYPE_STANDARD:
256
                switch (buffer->setup.bRequest.req)
257
                {
258
                case USB_SETUP_BREQUEST_GET_STATUS:
259
                    if (buffer->setup.wLength != 2 || buffer->setup.wValue) break;
260
                    data->buffer->raw[0] = 0;
261
                    data->buffer->raw[1] = data->driver->get_stall(data, ep);
262
                    addr = data->buffer;
263
                    size = 2;
264
                    break;
265
                case USB_SETUP_BREQUEST_CLEAR_FEATURE:
266
                    if (buffer->setup.wLength || buffer->setup.wValue) break;
267
                    data->driver->set_stall(data, ep, false);
268
                    size = 0;
269
                    break;
270
                case USB_SETUP_BREQUEST_SET_FEATURE:
271
                    if (buffer->setup.wLength || buffer->setup.wValue) break;
272
                    data->driver->set_stall(data, ep, true);
273
                    size = 0;
274
                    break;
275
                default: break;
276
                }
277
                break;
278
                default: break;
279
            }
280
            break;
281
        }
282
        default: break;
283
    }
284
    }
285
    // See comment at the top of this function
286
    if (size == 0) usb_ep0_start_tx(data, NULL, 0);
287
    else if (size > 0) usb_ep0_start_tx(data, addr, size);
288
    else if (size >= -2) usb_ep0_expect_setup(data);
289
}
290
 
291
static void usb_handle_ep0_data(const struct usb_instance* data, union usb_ep0_buffer* buffer, int size)
292
{
293
    // We don't accept any commands that have an OUT payload. Just STALL it, no matter what it was.
294
    usb_ep0_expect_setup(data);
295
}
296
 
297
void usb_handle_bus_reset(const struct usb_instance* data, int highspeed)
298
{
299
    data->state->current_address = 0;
300
    usb_unconfigure(data);
301
    if (data->bus_reset) data->bus_reset(data, highspeed);
302
    int c, i;
303
    for (c = 0; c < data->configuration_count; c++)
304
    {
305
        const struct usb_configuration* configuration = data->configurations[c];
306
        for (i = 0; i < configuration->interface_count; i++)
307
        {
308
            struct usb_interface* interface = configuration->interfaces[i];
309
            if (interface->bus_reset) interface->bus_reset(data, c, i, highspeed);
310
        }
311
    }
312
}
313
 
314
void usb_handle_timeout(const struct usb_instance* data, union usb_endpoint_number epnum, int bytesleft)
315
{
316
    // Hm, the host didn't fetch our EP0 IN packet, so we feel a bit offended.
317
    // Refuse to accept any transfers, until we get a new SETUP token.
318
    if (!epnum.number) usb_ep0_expect_setup(data);
319
    else
320
    {
321
        int epidx;
322
        int ifidx;
323
        const struct usb_endpoint* endpoint = usb_find_endpoint(data, epnum, &epidx, &ifidx);
324
        if (!endpoint) data->driver->unconfigure_ep(data, epnum);
325
        else if (endpoint->timeout) endpoint->timeout(data, ifidx, epidx, bytesleft);
326
    }
327
}
328
 
329
void usb_handle_xfer_complete(const struct usb_instance* data, union usb_endpoint_number epnum, int bytesleft)
330
{
331
    if (!epnum.number)
332
    {
333
        // If this was EP0 IN, stall the pipe. There will only ever be one transfer for each
334
        // SETUP transaction, and the next SETUP packet will clear the stall.
335
        if (epnum.direction == USB_ENDPOINT_DIRECTION_IN) usb_set_stall(data, epnum, 1);
336
        else if (!data->ep0_data_hook || !data->ep0_data_hook(data, data->buffer, 64 - bytesleft))
337
            usb_handle_ep0_data(data, data->buffer, 64 - bytesleft);
338
    }
339
    else
340
    {
341
        int epidx;
342
        int ifidx;
343
        const struct usb_endpoint* endpoint = usb_find_endpoint(data, epnum, &epidx, &ifidx);
344
        if (!endpoint) usb_unconfigure_ep(data, epnum);
345
        else if (endpoint->xfer_complete) endpoint->xfer_complete(data, ifidx, epidx, bytesleft);
346
    }
347
}
348
 
349
void usb_handle_setup_received(const struct usb_instance* data, union usb_endpoint_number epnum, int back2back)
350
{
351
    if (!epnum.number)
352
    {
353
        // Figure out the location of the newest SETUP packet if there were
354
        // multiple back to back ones. If there were more than 3 SETUP packets
355
        // in a row, the OTG will take care of it, so we're on the safe side here.
356
        void* addr = &data->buffer->raw[8 * (back2back - 1)];
357
        union usb_ep0_buffer* buffer = (union usb_ep0_buffer*)addr;
358
        if (!data->ep0_setup_hook || !data->ep0_setup_hook(data, buffer)) usb_handle_ep0_setup(data, buffer);
359
    }
360
    else
361
    {
362
        int epidx;
363
        int ifidx;
364
        const struct usb_endpoint* endpoint = usb_find_endpoint(data, epnum, &epidx, &ifidx);
365
        if (!endpoint) usb_unconfigure_ep(data, epnum);
366
        else if (endpoint->setup_received) endpoint->setup_received(data, ifidx, epidx, back2back);
367
    }
368
}
369
 
370
void usb_init(const struct usb_instance* data)
371
{
372
    // Initialize data struct
373
    data->state->current_address = 0;
374
    data->state->current_configuration = 0;
375
 
376
    // Initialize driver
377
    data->driver->init(data);
378
}
379
 
380
void usb_exit(const struct usb_instance* data)
381
{
382
    // Shut down driver
383
    data->driver->exit(data);
384
 
385
    // Unconfigure everything
386
    usb_unconfigure(data);
387
}
388