Documentation/driver-model/class.txt

Chinese translated version of Documentation/blockdev/cpqarray.txt

If you have any comment or update to the content, please contact the
original document maintainer directly.  However, if you have a problem
communicating in English you can also ask the Chinese maintainer for
help.  Contact the Chinese maintainer if this translation is outdated
or if there is a problem with the translation.

Chinese maintainer: wuyan<1481494885@qq.com>
---------------------------------------------------------------------
Documentation/driver-model/class.txt的中文翻译

如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文
交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻
译存在问题，请联系中文版维护者。

中文版校译者： 吴燕 1481494885@qq.com如果本翻译更新不及时或者翻译存在问题，请联系中文版维护者。

中文版维护者： 吴燕 1481494885@qq.com

中文版翻译者： 吴燕 1481494885@qq.com

 
   Device Classes
   Introduction
   ~~~~~~~~~~~~
   A device class describes a type of device, like an audio or network
   device. The following device classes have been identified:
   <Insert List of Device Classes Here>

 设备类别 介绍

~~~~~~~~
设备类型描述了某种类型的设备，比如音频设备或者网络设备。下面的这些设备类别已经被识别了：

<这里插入设备类别列表>

  
  Each device class defines a set of semantics and a programming interface
  that devices of that class adhere to. Device drivers are the
  implementation of that programming interface for a particular device on
  a particular bus. 
  
  Device classes are agnostic with respect to what bus a device resides
  on.

     每个设备类别定义了一组语义和支持该类设备的编程接口。设备驱动程序为一个在特定总线的特定设备实现编程接口。

    考虑到设备该待在什么总线上，设备类别是不可知的。

  Programming Interface
  ~~~~~~~~~~~~~~~~~~~~~
  The device class structure looks like: 
  
  
  typedef int (*devclass_add)(struct device *);
  typedef void (*devclass_remove)(struct device *);
  
  See the kerneldoc for the struct class.

   编程接口

   ~~~~~~~~~~~~~~~~~~~~

  设备类结构如下：

  typedef int (*devclass_add)(struct device *);

  typedef void (*devclass_remove)(struct device *);

  把kerneldoc视为struct类。

  

  
  A typical device class definition would look like: 
  
  
  
  Each device class structure should be exported in a header file so it
  can be used by drivers, extensions and interfaces.
  
  Device classes are registered and unregistered with the core using: 
  
  
  

    一个典型的设备类定义如下：

   struct device_class input_devclass = {

          .name           = "input",
          .add_device     = input_add_device,
          .remove_device  = input_remove_device,
  };

    每一个设备类结构应该在一个头文件导出这样它可以被驱动程序、扩展和接口使用。
  设备类注册和未注册的核心使用:

   int devclass_register(struct device_class * cls); 

   void devclass_unregister(struct device_class * cls);

  
  Devices
  ~~~~~~~
  As devices are bound to drivers, they are added to the device class
  that the driver belongs to. Before the driver model core, this would
  typically happen during the driver's probe() callback, once the device
  has been initialized. It now happens after the probe() callback
  finishes from the core. 
  

  设备

  ~~~~~~

  随着设备都被绑定到驱动上，他们也被加到了驱动属于的设备类里。在驱动模型的核心之前，

  这通常会发生在驱动探针回调的时候，一旦设备被初始化。现在它发生在探针回调完成之后。

  The device is enumerated in the class. Each time a device is added to
  the class, the class's devnum field is incremented and assigned to the
  device. The field is never decremented, so if the device is removed
  from the class and re-added, it will receive a different enumerated
  value. 
  

该设备在类中被枚举。每一次一个设备被加到类里，类的devnum字段是递增的而且被分配到设备。

这个字段是从来不递减的，所以如果设备被从类中移除并且重新添加，它讲得到不同的枚举值。

  The class is allowed to create a class-specific structure for the
  device and store it in the device's class_data pointer. 
  
  There is no list of devices in the device class. Each driver has a
  list of devices that it supports. The device class has a list of
  drivers of that particular class. To access all of the devices in the
  class, iterate over the device lists of each driver in the class.

类被允许为设备创建一个类专用的结构，并把它储存在设备的类数据指针里。在设备类

里没有设备列表。每个驱动都有一个它所支持的设备列表。设备类有一个特定类的驱动

的列表。为了访问所有的设备，遍历类中每个驱动的设备列表。

 

  Device Drivers
  ~~~~~~~~~~~~~~
  Device drivers are added to device classes when they are registered
  with the core. A driver specifies the class it belongs to by setting
  the struct device_driver::devclass field. 
 

设备驱动 

~~~~~~~~~~~~~~~~

当设备驱动程序与核心一起注册的时候，它们被添加到设备类。一个设备通过设置结构体

device_driver::devclass field来指定它属于的类。

  
  sysfs directory structure
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  There is a top-level sysfs directory named 'class'. 
  
  Each class gets a directory in the class directory, along with two
  default subdirectories:
  
          class/
          `-- input
              |-- devices
              `-- drivers
 

目录结构 
~~~~~~~~~~~~~~~~~~~~
这里有个最高级别的目录，名为‘class’。
每个类在类目录中得到一个目录，连同两个默认的子目录。
 class/
          `-- input
              |-- devices
              `-- drivers


  
  Drivers registered with the class get a symlink in the drivers/ directory 
  that points to the driver's directory (under its bus directory):
  
     class/
     `-- input
         |-- devices
         `-- drivers
             `-- usb:usb_mouse -> ../../../bus/drivers/usb_mouse/

驱动程序注册类会在驱动/目录中得到指向驱动目录的符号链接（在它的usb目录下）：
class/`

-- input
|-- devices
`-- drivers
`-- usb:usb_mouse -> ../../../bus/drivers/usb_mouse/

 Each device gets a symlink in the devices/ directory that points to the 
 device's directory in the physical hierarchy:
 
    class/
    `-- input
        |-- devices
        |   `-- 1 -> ../../../root/pci0/00:1f.0/usb_bus/00:1f.2-1:0/
        `-- drivers

每个设备在设备/目录中得到一在物理层次个指向设备的目录符号链接：
class/
`-- input |-- devices
| `-- 1 -> ../../../root/pci0/00:1f.0/usb_bus/00:1f.2-1:0/
`-- drivers

 
 Exporting Attributes
 ~~~~~~~~~~~~~~~~~~~~
 struct devclass_attribute {
         struct attribute        attr;
         ssize_t (*show)(struct device_class *, char * buf, size_t count, loff_t off);
         ssize_t (*store)(struct device_class *, const char * buf, size_t count, loff_t off);
 };
 
 Class drivers can export attributes using the DEVCLASS_ATTR macro that works
 similarly to the DEVICE_ATTR macro for devices. For example, a definition 
 like this:
 
 static DEVCLASS_ATTR(debug,0644,show_debug,store_debug);
 
 is equivalent to declaring:
 
 static devclass_attribute devclass_attr_debug;

导出属性

~~~~~~~~~~~~~~~
struct attribute attr;
ssize_t (*show)(struct device_class *, char * buf, size_t count, loff_t off);
ssize_t (*store)(struct device_class *, const char * buf, size_t count, loff_t off);
};

类驱动程序可以用DEVCLASS_ATTR宏导出属性，类似设备的DEVICE_ATTR宏。例如，一个这样的定义：

static DEVCLASS_ATTR(debug,0644,show_debug,store_debug); 
is equivalent to declaring: 
static devclass_attribute devclass_attr_debug;

 
 The bus driver can add and remove the attribute from the class's
 sysfs directory using:
 
 int devclass_create_file(struct device_class *, struct devclass_attribute *);
 void devclass_remove_file(struct device_class *, struct devclass_attribute *);
 
 In the example above, the file will be named 'debug' in placed in the
 class's directory in sysfs. 

驱动可以从类的sysfs目录中增加和删除属性：
int devclass_create_file(struct device_class *, struct devclass_attribute *);
void devclass_remove_file(struct device_class *, struct devclass_attribute *);

在上面的例子中，文件将会被命名为‘debug’被放在sysfs中类的目录里。

 
 
 Interfaces
 ~~~~~~~~~~
 There may exist multiple mechanisms for accessing the same device of a
 particular class type. Device interfaces describe these mechanisms. 
 
 When a device is added to a device class, the core attempts to add it
 to every interface that is registered with the device class.
 

接口

~~~~~~~~~~~~~~~~~~

可能存在多个机制来访问特殊类的相同设备。设备接口描述这些机制。

当一个设备被添加到设备类，核心试图把它加入到每个设备类注册的接口。