第16章 USB主机、设备与Gadget驱动之USB设备驱动（三）

16.3.5　USB键盘驱动

    在Linux系统中，键盘被认定为标准输入设备，对于USB键盘，驱动主要由两部分组成：usb_driver（USB外设驱动）的成员函数和输入设备驱动的input_event获取和报告。

    USB键盘设备驱动的模块加载和卸载函数，分别注册和注销对应于USB键盘的usb_driver结构体usb_kbd_driver，代码清单16.26所示为模块加载与卸载函数以及usb_driver结构体的定义。

    代码清单16.26　USB键盘设备驱动的模块加载与卸载函数以及usb_driver结构体

static struct usb_device_id usb_kbd_id_table [] = {
{ USB_INTERFACE_INFO(USB_INTERFACE_CLASS_HID, USB_INTERFACE_SUBCLASS_BOOT,
USB_INTERFACE_PROTOCOL_KEYBOARD) },
{ } /* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, usb_kbd_id_table);

static struct usb_driver usb_kbd_driver = {
.name = "usbkbd",
.probe = usb_kbd_probe,
.disconnect = usb_kbd_disconnect,
.id_table = usb_kbd_id_table,
};

module_usb_driver(usb_kbd_driver);

    usb_driver的probe（）函数，输入设备的初始化和注册，USB键盘使用的中断URB和控制URB的初始化，设置接口的私有数据，如代码清单16.27所示。

代码清单16.27　USB键盘设备驱动的probe（）函数

static int usb_kbd_probe(struct usb_interface *iface,
const struct usb_device_id *id)
{
struct usb_device *dev = interface_to_usbdev(iface);
struct usb_host_interface *interface;
struct usb_endpoint_descriptor *endpoint;
struct usb_kbd *kbd;
struct input_dev *input_dev; // 输入设备
int i, pipe, maxp;
int error = -ENOMEM;

interface = iface->cur_altsetting;
if (interface->desc.bNumEndpoints != 1)
return -ENODEV;


endpoint = &interface->endpoint[0].desc;
if (!usb_endpoint_is_int_in(endpoint))
return -ENODEV;

pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));

kbd = kzalloc(sizeof(struct usb_kbd), GFP_KERNEL); // 分配内存
input_dev = input_allocate_device(); // 动态初始化input_dev
if (!kbd || !input_dev)
goto fail1;

        

        /* 分配内存 */

if (usb_kbd_alloc_mem(dev, kbd))
goto fail2;

kbd->usbdev = dev;
kbd->dev = input_dev;
spin_lock_init(&kbd->leds_lock);

if (dev->manufacturer)
strlcpy(kbd->name, dev->manufacturer, sizeof(kbd->name));

if (dev->product) {
if (dev->manufacturer)
strlcat(kbd->name, " ", sizeof(kbd->name));
strlcat(kbd->name, dev->product, sizeof(kbd->name));
}

if (!strlen(kbd->name))
snprintf(kbd->name, sizeof(kbd->name),
"USB HIDBP Keyboard %04x:%04x",
le16_to_cpu(dev->descriptor.idVendor),
le16_to_cpu(dev->descriptor.idProduct));

usb_make_path(dev, kbd->phys, sizeof(kbd->phys));
strlcat(kbd->phys, "/input0", sizeof(kbd->phys));
        /* 输入设备初始化 */
input_dev->name = kbd->name;
input_dev->phys = kbd->phys;
usb_to_input_id(dev, &input_dev->id);
input_dev->dev.parent = &iface->dev;

input_set_drvdata(input_dev, kbd);

input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_LED) |
BIT_MASK(EV_REP);
input_dev->ledbit[0] = BIT_MASK(LED_NUML) | BIT_MASK(LED_CAPSL) |
BIT_MASK(LED_SCROLLL) | BIT_MASK(LED_COMPOSE) |
BIT_MASK(LED_KANA);

for (i = 0; i < 255; i++)
set_bit(usb_kbd_keycode[i], input_dev->keybit);
clear_bit(0, input_dev->keybit);

input_dev->event = usb_kbd_event;
input_dev->open = usb_kbd_open;
input_dev->close = usb_kbd_close;
        /* 中断urb初始化 */
usb_fill_int_urb(kbd->irq, dev, pipe,
kbd->new, (maxp > 8 ? 8 : maxp),
usb_kbd_irq, kbd, endpoint->bInterval);
kbd->irq->transfer_dma = kbd->new_dma;
kbd->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

kbd->cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE;
kbd->cr->bRequest = 0x09;
kbd->cr->wValue = cpu_to_le16(0x200);
kbd->cr->wIndex = cpu_to_le16(interface->desc.bInterfaceNumber);
kbd->cr->wLength = cpu_to_le16(1);
        /* 控制urb初始化 */
usb_fill_control_urb(kbd->led, dev, usb_sndctrlpipe(dev, 0),
     (void *) kbd->cr, kbd->leds, 1,
     usb_kbd_led, kbd);
kbd->led->transfer_dma = kbd->leds_dma;
kbd->led->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
        /* 注册输入设备 */
error = input_register_device(kbd->dev);
if (error)
goto fail2;

usb_set_intfdata(iface, kbd); /* 设置接口私有数据 */
device_set_wakeup_enable(&dev->dev, 1);
return 0;

fail2:
usb_kbd_free_mem(dev, kbd);
fail1:
input_free_device(input_dev);
kfree(kbd);
return error;

}

    usb_driver的断开函数，设置接口私有数据为NULL、终止已提交的URB、注销输入设备，如代码清单16.28所示。

    代码清单16.28　USB键盘设备驱动的断开函数

static void usb_kbd_disconnect(struct usb_interface *intf)
{
struct usb_kbd *kbd = usb_get_intfdata (intf);

usb_set_intfdata(intf, NULL); /* 设置接口私有数据为NULL */
if (kbd) {
usb_kill_urb(kbd->irq); /* 终止已提交的URB */
input_unregister_device(kbd->dev); /* 注销输入设备 */
usb_kill_urb(kbd->led); /* 终止已提交的URB */
usb_kbd_free_mem(interface_to_usbdev(intf), kbd); /*释放内存*/
kfree(kbd);
}

}

    键盘主要依赖于中断传输模式，在键盘中断URB的完成函数usb_kbd_irq（）中，通过input_report_key（）报告按键事件，通过input_sync（）报告同步事件，如代码清单16.29所示。

代码清单16.29　USB键盘设备驱动的中断URB完成函数

static void usb_kbd_irq(struct urb *urb)
{
struct usb_kbd *kbd = urb->context;
int i;

switch (urb->status) {
case 0: /* success */
break;
case -ECONNRESET: /* unlink */
case -ENOENT:
case -ESHUTDOWN:
return;
/* -EPIPE:  should clear the halt */
default: /* error */
goto resubmit;

}

        /* 报告按键事件 */

for (i = 0; i < 8; i++)
input_report_key(kbd->dev, usb_kbd_keycode[i + 224], (kbd->new[0] >> i) & 1);

for (i = 2; i < 8; i++) {
if (kbd->old[i] > 3 && memscan(kbd->new + 2, kbd->old[i], 6) == kbd->new + 8) {
if (usb_kbd_keycode[kbd->old[i]])
input_report_key(kbd->dev, usb_kbd_keycode[kbd->old[i]], 0);
else
hid_info(urb->dev, "Unknown key (scancode %#x) released.\n", kbd->old[i]);
}
if (kbd->new[i] > 3 && memscan(kbd->old + 2, kbd->new[i], 6) == kbd->old + 8) {
if (usb_kbd_keycode[kbd->new[i]])
input_report_key(kbd->dev, usb_kbd_keycode[kbd->new[i]], 1);
else
hid_info(urb->dev, "Unknown key (scancode %#x) pressed.\n", kbd->new[i]);
}
}
       /* 报告同步事件 */
input_sync(kbd->dev);
memcpy(kbd->old, kbd->new, 8);

resubmit:
i = usb_submit_urb (urb, GFP_ATOMIC);
if (i)
hid_err(urb->dev, "can't resubmit intr, %s-%s/input0, status %d",
kbd->usbdev->bus->bus_name,
kbd->usbdev->devpath, i);
}

总结：

    从USB键盘驱动实例中，进一步看到usb_driver本身只是起一个挂接总线的作用，具体设备类型的驱动是工作的主体，例如键盘就是input、USB串口就是tty，只是在设备底层进行硬件访问时，调用的都是与URB（USB请求块）相关的接口，这套USB核心层API——URB的存在使得无须关心底层USB主机控制器的具体细节，因此，USB设备驱动变得与平台无关，同样的驱动可适用于不同的SoC。