学习笔记 - USB 鼠标驱动浅析 -

标题: 学习笔记 - USB 鼠标驱动浅析 [打印本页]

作者: 51hei小林 时间: 2016-9-24 22:30
标题: 学习笔记 - USB 鼠标驱动浅析
一直很好奇 USB 如此复杂的协议，在 Linux 中如何写 USB 设备驱动。刚好是微信所关注的一些 Linux 公众号有提到 usb 骨架程序 usb-skeleton.c ，发现没有想象中那么难。从网上查了一些相关的资料，先大概摸一下流程，就选了 USB 鼠标的驱动。有个大体的印象，再接着尝试深入学习。USB设备那么流行，搞清楚了益处多多啊。哈哈。。。

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/usb/input.h>
#include <linux/hid.h>

/* for apple IDs */
#ifdef CONFIG_USB_HID_MODULE
#include "../hid-ids.h"
#endif

/*
* Version Information
*/
#define DRIVER_VERSION "v1.6"
#define DRIVER_AUTHOR "Vojtech Pavlik <vojtech@ucw.cz>"
#define DRIVER_DESC "USB HID Boot Protocol mouse driver"
#define DRIVER_LICENSE "GPL"

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE(DRIVER_LICENSE);

/*****************************
* 大体流程：
* 1、声明USB设备列表
* 2、注册 USB 设备驱动
* 3、USB 设备接入被检测到
* 4、创建并填充 input 设备
* 5、设置 USB 数据获取回调
* 6、通过 input 上报相应的键值
*****************************/

struct usb_mouse
{
char name[128];
char phys[64];
struct usb_device *usbdev;
struct input_dev *dev;
struct urb *irq;

signed char *data;
dma_addr_t data_dma;
};

/* 这个函数其实是回调函数而不是中断 */
static void usb_mouse_irq(struct urb *urb)
{
struct usb_mouse *mouse = urb->context;
signed char *data = mouse->data;
struct input_dev *dev = mouse->dev;
int status;

// 检查 USB 传输是否成功
switch (urb->status)
{
      case 0:       /* success */
         break;

      case -ECONNRESET: /* unlink */
      case -ENOENT:
      case -ESHUTDOWN:
         return;

         /* -EPIPE:  should clear the halt */
      default:       /* error */
         goto resubmit;
}

// 报告鼠标按键情况利用输入子系统向系统发送键值
input_report_key(dev, BTN_LEFT, data[0] & 0x01);
input_report_key(dev, BTN_RIGHT,  data[0] & 0x02);
input_report_key(dev, BTN_MIDDLE, data[0] & 0x04);
input_report_key(dev, BTN_SIDE, data[0] & 0x08);
input_report_key(dev, BTN_EXTRA,  data[0] & 0x10);

input_report_rel(dev, REL_X,    data[1]);
input_report_rel(dev, REL_Y,    data[2]);
input_report_rel(dev, REL_WHEEL, data[3]);

input_sync(dev);

resubmit:  // 提交下次传输
status = usb_submit_urb (urb, GFP_ATOMIC);
if (status)
{
      err ("can't resubmit intr, %s-%s/input0, status %d",
         mouse->usbdev->bus->bus_name,
         mouse->usbdev->devpath, status);
}

return ;
}

static int usb_mouse_open(struct input_dev *dev)
{
struct usb_mouse *mouse = input_get_drvdata(dev);

// 提交 URB 传输，这样才会从 USB 鼠标拿到数据
mouse->irq->dev = mouse->usbdev;
if (usb_submit_urb(mouse->irq, GFP_KERNEL))
      return -EIO;

return 0;
}

static void usb_mouse_close(struct input_dev *dev)
{
struct usb_mouse *mouse = input_get_drvdata(dev);

// 停止传输
usb_kill_urb(mouse->irq);
}

static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
// 设备描述
struct usb_device *dev = interface_to_usbdev(intf);
// 接口设置描述
struct usb_host_interface *interface;
// 端点描述
struct usb_endpoint_descriptor *endpoint;

struct usb_mouse *mouse;
struct input_dev *input_dev;
int pipe, maxp;
int error = -ENOMEM;

// 获取当前接口设置
interface = intf->cur_altsetting;

// 根据 HID 规范，鼠标只有一个端点(不包含0号控制端点)
if (interface->desc.bNumEndpoints != 1)
      return -ENODEV;

// 获取端点 0 描述符
endpoint = &interface->endpoint[0].desc;

// 根据 HID 规范，鼠标唯一的端点应为中断端点并且为输入的断点
if (!usb_endpoint_is_int_in(endpoint))
      return -ENODEV;

// 生成中断管道
pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);

// 返回该端点能够传输的最大的包长度，鼠标的返回的最大数据包为 4 字节
maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));

// 创建 input 设备
mouse = kzalloc(sizeof(struct usb_mouse), GFP_KERNEL);
input_dev = input_allocate_device();
if (!mouse || !input_dev)
      goto fail1;

// 申请内存空间用于数据传输, data 为指向该空间的地址
mouse->data = usb_alloc_coherent(dev, 8, GFP_ATOMIC, &mouse->data_dma);
if (!mouse->data)
      goto fail1;

// 分配 URB
mouse->irq = usb_alloc_urb(0, GFP_KERNEL);
if (!mouse->irq)
      goto fail2;

// 保存 USB 设备和 input 设备
mouse->usbdev = dev;
mouse->dev = input_dev;

// 这里拷贝字符串主要是为给输入子系统命名的
if (dev->manufacturer)
      strlcpy(mouse->name, dev->manufacturer, sizeof(mouse->name));

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

      strlcat(mouse->name, dev->product, sizeof(mouse->name));
}

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

// usb_make_path 用来获取 USB 设备在 Sysfs 中的路径
usb_make_path(dev, mouse->phys, sizeof(mouse->phys));
strlcat(mouse->phys, "/input0", sizeof(mouse->phys));

// 输入设备驱动
input_dev->name = mouse->name;
input_dev->phys = mouse->phys;
usb_to_input_id(dev, &input_dev->id);
input_dev->dev.parent = &intf->dev;

// 声明此输出设备所具有的特性，如按键、坐标值等
input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
input_dev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);
input_dev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
input_dev->keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) | BIT_MASK(BTN_EXTRA);
input_dev->relbit[0] |= BIT_MASK(REL_WHEEL);

input_set_drvdata(input_dev, mouse);

input_dev->open = usb_mouse_open; // 当上层打开时，会启动USB控制器从USB鼠标中取数据
input_dev->close = usb_mouse_close; // 当上层关闭时，会停止USB控制器从USB鼠标中取数据

// 初始化中断 URB
// pipe:取数据的地方  mouse->data:数据存放地方
// 当从 USB 取完数据之后，调用 usb_mouse_irq()
usb_fill_int_urb(mouse->irq, dev, pipe, mouse->data, (maxp > 8 ? 8 : maxp), usb_mouse_irq, mouse, endpoint->bInterval);

// DMA 相关
mouse->irq->transfer_dma = mouse->data_dma;
// USB控制器自带 transfer_dma 所以需要设置 URB_NO_TRANSFER_DMA_MAP 标志，告知 HCD 不需要做 DMA 映射
mouse->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

// 将 mouse 指针保存到 intf 的 dev 成员中
error = input_register_device(mouse->dev);
if (error)
      goto fail3;

// 将 mouse 指针保存到 intf 的 dev 成远中
usb_set_intfdata(intf, mouse);

return 0;

fail3:
usb_free_urb(mouse->irq);
fail2:
usb_free_coherent(dev, 8, mouse->data, mouse->data_dma);
fail1:
input_free_device(input_dev);
kfree(mouse);
return error;
}

static void usb_mouse_disconnect(struct usb_interface *intf)
{
struct usb_mouse *mouse = usb_get_intfdata (intf);

// 当 USB 鼠标被拔掉之后，需要释放 USB 和 input
usb_set_intfdata(intf, NULL);
if (mouse)
{
      usb_kill_urb(mouse->irq);
      input_unregister_device(mouse->dev);
      usb_free_urb(mouse->irq);
      usb_free_coherent(interface_to_usbdev(intf), 8, mouse->data, mouse->data_dma);
      kfree(mouse);
}
}

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

MODULE_DEVICE_TABLE (usb, usb_mouse_id_table);

static struct usb_driver usb_mouse_driver =
{
.name    = "usbmouse",
.probe    = usb_mouse_probe,    // 当检测到USB鼠标接入之后会进行准备工作
.disconnect = usb_mouse_disconnect, // USB 设备拔出
.id_table = usb_mouse_id_table, // USB 设备列表
};

// 注册USB设备驱动
module_usb_driver(usb_mouse_driver);

欢迎光临 (http://www.51hei.com/bbs/)