summaryrefslogtreecommitdiffstats
path: root/firmware/usbstack/drivers/device/usb_serial.c
blob: a37813b01c45271dab397a8b0ee8484b40f73d21 (plain)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2007 by Christian Gmeiner
 *
 * All files in this archive are subject to the GNU General Public License.
 * See the file COPYING in the source tree root for full license agreement.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/

#include "usb_serial.h"
#include <string.h>

static struct usb_dcd_controller_ops* ops;

struct usb_device_driver usb_serial_driver = {
    .name =         "serial",
    .bind =         usb_serial_driver_bind,
    .unbind =       usb_serial_driver_unbind,
    .request =      usb_serial_driver_request,
    .suspend =      NULL,
    .resume =       NULL,
    .speed =        usb_serial_driver_speed,
};

/*-------------------------------------------------------------------------*/
/* usb descriptors */

/* TODO: implement strings */
#define GS_MANUFACTURER_STR_ID  0
#define GS_PRODUCT_STR_ID       0
#define GS_SERIAL_STR_ID        0
#define GS_BULK_CONFIG_STR_ID   0
#define GS_DATA_STR_ID          0

#define GS_BULK_CONFIG_ID       1

static struct usb_device_descriptor serial_device_desc = {
    .bLength =              USB_DT_DEVICE_SIZE,
    .bDescriptorType =      USB_DT_DEVICE,
    .bcdUSB =               0x0200,
    .bDeviceClass =         USB_CLASS_COMM,
    .bDeviceSubClass =      0,
    .bDeviceProtocol =      0,
    .idVendor =             0x0525,
    .idProduct =            0xa4a6,
    .iManufacturer =        GS_MANUFACTURER_STR_ID,
    .iProduct =             GS_PRODUCT_STR_ID,
    .iSerialNumber =        GS_SERIAL_STR_ID,
    .bNumConfigurations =   1,
};

static struct usb_config_descriptor serial_bulk_config_desc = {
    .bLength =              USB_DT_CONFIG_SIZE,
    .bDescriptorType =      USB_DT_CONFIG,

    .bNumInterfaces =       1,
    .bConfigurationValue =  GS_BULK_CONFIG_ID,
    .iConfiguration =       GS_BULK_CONFIG_STR_ID,
    .bmAttributes =         USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
    .bMaxPower =            1,
};

static struct usb_interface_descriptor serial_bulk_interface_desc = {
    .bLength =              USB_DT_INTERFACE_SIZE,
    .bDescriptorType =      USB_DT_INTERFACE,
    .bInterfaceNumber =     0,
    .bNumEndpoints =        2,
    .bInterfaceClass =      USB_CLASS_CDC_DATA,
    .bInterfaceSubClass =   0,
    .bInterfaceProtocol =   0,
    .iInterface =           GS_DATA_STR_ID,
};

static struct usb_endpoint_descriptor serial_fs_in_desc = {
    .bLength =              USB_DT_ENDPOINT_SIZE,
    .bDescriptorType =      USB_DT_ENDPOINT,
    .bEndpointAddress =     USB_DIR_IN,
    .bmAttributes =         USB_ENDPOINT_XFER_BULK,
    .wMaxPacketSize =       8,
};

static struct usb_endpoint_descriptor serial_fs_out_desc = {
    .bLength =              USB_DT_ENDPOINT_SIZE,
    .bDescriptorType =      USB_DT_ENDPOINT,
    .bEndpointAddress =     USB_DIR_OUT,
    .bmAttributes =         USB_ENDPOINT_XFER_BULK,
    .wMaxPacketSize =       8,
};

static struct usb_debug_descriptor serial_debug_desc = {
    .bLength =              sizeof(struct usb_debug_descriptor),
    .bDescriptorType =      USB_DT_DEBUG,
};

static struct usb_qualifier_descriptor serial_qualifier_desc = {
    .bLength =             sizeof(struct usb_qualifier_descriptor),
    .bDescriptorType =     USB_DT_DEVICE_QUALIFIER,
    .bcdUSB =              0x0200,
    .bDeviceClass =        USB_CLASS_COMM,
    .bNumConfigurations =  1,
};

struct usb_descriptor_header *serial_fs_function[] = {
    (struct usb_descriptor_header *) &serial_bulk_interface_desc,
    (struct usb_descriptor_header *) &serial_fs_in_desc,
    (struct usb_descriptor_header *) &serial_fs_out_desc,
    NULL,
};

/* USB 2.0 */
static struct usb_endpoint_descriptor serial_hs_in_desc = {
    .bLength =              USB_DT_ENDPOINT_SIZE,
    .bDescriptorType =      USB_DT_ENDPOINT,
    .bEndpointAddress =     USB_DIR_IN,
    .bmAttributes =         USB_ENDPOINT_XFER_BULK,
    .wMaxPacketSize =       512,
};

static struct usb_endpoint_descriptor serial_hs_out_desc = {
    .bLength =              USB_DT_ENDPOINT_SIZE,
    .bDescriptorType =      USB_DT_ENDPOINT,
    .bEndpointAddress =     USB_DIR_IN,
    .bmAttributes =         USB_ENDPOINT_XFER_BULK,
    .wMaxPacketSize =       512,
};

struct usb_descriptor_header *serial_hs_function[] = {
    (struct usb_descriptor_header *) &serial_bulk_interface_desc,
    (struct usb_descriptor_header *) &serial_hs_in_desc,
    (struct usb_descriptor_header *) &serial_hs_out_desc,
    NULL,
};

#define BUFFER_SIZE 100
uint8_t buf[BUFFER_SIZE];

struct usb_response res;

/* helper functions */
static int config_buf(uint8_t *buf, uint8_t type, unsigned index);
static int set_config(int config);

struct device {
    struct usb_ep* in;
    struct usb_ep* out;
    uint32_t used_config;
    struct usb_descriptor_header** descriptors;
};

static struct device dev;

/*-------------------------------------------------------------------------*/

void usb_serial_driver_init(void)
{
    logf("usb serial: register");
    usb_device_driver_register(&usb_serial_driver);
}

/*-------------------------------------------------------------------------*/

int usb_serial_driver_bind(void* controler_ops)
{
    logf("usb serial: bind");
    ops = controler_ops;

    /* serach and asign endpoints */
    usb_ep_autoconfig_reset();

    dev.in = usb_ep_autoconfig(&serial_fs_in_desc);
    if (!dev.in) {
        goto autoconf_fail;
    }
    dev.in->claimed = true;
    logf("usb serial: in: %s", dev.in->name);

    dev.out = usb_ep_autoconfig(&serial_fs_out_desc);
    if (!dev.out) {
        goto autoconf_fail;
    }
    dev.out->claimed = true;
    logf("usb serial: out: %s", dev.out->name);

    /* update device decsriptor */
    serial_device_desc.bMaxPacketSize0 = ops->ep0->maxpacket;

    /* update qualifie descriptor */
    serial_qualifier_desc.bMaxPacketSize0 = ops->ep0->maxpacket;

    /* update debug descriptor */
    serial_debug_desc.bDebugInEndpoint = dev.in->ep_num;
    serial_debug_desc.bDebugOutEndpoint = dev.out->ep_num;

    /* update hs descriptors as we asume that endpoints are the same for fs and hs */
    serial_hs_in_desc.bEndpointAddress = serial_fs_in_desc.bEndpointAddress;
    serial_hs_out_desc.bEndpointAddress = serial_fs_out_desc.bEndpointAddress;

    return 0;

autoconf_fail:
    logf("failed to find endpoints");
    return -EOPNOTSUPP;
}

void usb_serial_driver_unbind(void) {

    /* disable endpoints... */
}

int usb_serial_driver_request(struct usb_ctrlrequest* request)
{
    int ret = -EOPNOTSUPP;
    logf("usb serial: request");

    res.length = 0;
    res.buf = NULL;

    switch (request->bRequestType & USB_TYPE_MASK) {
    case USB_TYPE_STANDARD:

        switch (request->bRequest) {
        case USB_REQ_GET_DESCRIPTOR:

            switch (request->wValue >> 8) {
            case USB_DT_DEVICE:
                logf("usb serial: sending device desc");
                ret = MIN(sizeof(struct usb_device_descriptor), request->wLength);
                res.buf = &serial_device_desc;
                break;

            case USB_DT_DEVICE_QUALIFIER:
                logf("usb serial: sending qualifier dec");
                ret = MIN(sizeof(struct usb_qualifier_descriptor), request->wLength);
                res.buf = &serial_qualifier_desc;
                break;

            case USB_DT_OTHER_SPEED_CONFIG:
            case USB_DT_CONFIG:
                logf("usb serial: sending config desc");

                ret = config_buf(buf, request->wValue >> 8, request->wValue & 0xff);
                if (ret >= 0) {
                    logf("%d, vs %d", request->wLength, ret);
                    ret = MIN(request->wLength, (uint16_t)ret);
                }
                res.buf = buf;
                break;

            case USB_DT_DEBUG:
                logf("usb serial: sending debug desc");
                ret = MIN(sizeof(struct usb_debug_descriptor), request->wLength);
                res.buf = &serial_debug_desc;
                break;
            }
            break;

        case USB_REQ_SET_CONFIGURATION:
            logf("usb serial: set configuration %d", request->wValue);
            ret = set_config(request->wValue);
            break;

        case USB_REQ_GET_CONFIGURATION:
            logf("usb serial: get configuration");
            ret = 1;
            res.buf = &dev.used_config;
            break;
        }
    }

    if (ret >= 0) {
        res.length = ret;
        ret = ops->send(NULL, &res);
    }

    return ret;
}

void usb_serial_driver_speed(enum usb_device_speed speed)
{
    switch (speed) {
    case USB_SPEED_HIGH:
        logf("usb serial: using highspeed");
        dev.descriptors = serial_hs_function;
        break;
    default:
        logf("usb serial: using fullspeed");
        dev.descriptors = serial_fs_function;
        break;
    }
}

/*-------------------------------------------------------------------------*/
/* helper functions */

static int config_buf(uint8_t *buf, uint8_t type, unsigned index)
{
    int len;

    /* TODO check index*/
    (void)index;

    len = usb_stack_configdesc(&serial_bulk_config_desc, buf, BUFFER_SIZE, dev.descriptors);
    if (len < 0) {
        return len;
    }
    ((struct usb_config_descriptor *)buf)->bDescriptorType = type;
    return len;
}

static int set_config(int config)
{
    /* TODO check config*/

    /* enable endpoints */
    logf("setup %s", dev.in->name);
    ops->enable(dev.in, (struct usb_endpoint_descriptor*)dev.descriptors[1]);
    logf("setup %s", dev.out->name);
    ops->enable(dev.out, (struct usb_endpoint_descriptor*)dev.descriptors[2]);

    /* store config */
    logf("using config %d", config);
    dev.used_config = config;

    return 0;
}