Uotan Wiki · 刷机百科 - 用户贡献 [zh-cn]

USB Gadget

2024-03-20T04:06:56Z

BigfootACA：

= Linux USB Gadget =

== 概述 ==

Linux在configfs中提供了usb_gadget用于支持USB设备模式。[[关于USB]]

== 准备configfs ==

在默认情况下，系统会自动挂载configfs，根据发行版不同，可能会挂在到不同的目录：

{| class="wikitable"
|-
! 系统
! 目录
|-
| Android
| /config
|-
| GNU/Linux
| /sys/kernel/config
|}

也可以通过以下命令来查看

<pre>mount | grep configfs</pre>
<pre class="">configfs on /sys/kernel/config type configfs (rw,nosuid,nodev,noexec,relatime)</pre>
如果没有挂载，也可以通过以下命令挂载

<pre>mount -t configfs configfs /sys/kernel/config</pre>
注：usb_gadget的configfs接口由模块<code>libcomposite</code>提供

== 创建gadget ==

简单的使用mkdir即可创建一个gadget。如要创建一个名为my_gadget：

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget</pre>
创建完成后，configfs会自动添加虚拟文件，以下是参照表

{| class="wikitable"
|-
! 文件/文件夹名称
! 描述
|-
| bcdDevice
| 设备版本，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| bcdUSB
| USB的协议版本，使用带0x前缀的四个十六进制数字（0x0200，0x0301）
|-
| idProduct
| USB设备的产品ID，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| idVendor
| USB设备的制造商ID，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| bDeviceClass
| USB设备识别的设备类，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bDeviceSubClass
| USB设备识别的设备子类，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bDeviceProtocol
| USB设备识别的设备协议，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bMaxPacketSize0
| 单次包最大传输大小
|-
| configs/
| gadget的配置文件
|-
| functions/
| gadget的子功能
|-
| strings/
| 向主机上报的设备名称
|-
| max_speed
| 支持的最大速度
|-
| os_desc
| 向主机展示的操作系统相关的描述
|-
| UDC
| 使用的USB设备控制器，可以在<code>/sys/class/udc</code>中选择
|}

Vendor ID、Product ID列表：http://www.linux-usb.org/usb.ids

Class、SubClass、Protocol列表：https://www.usb.org/defined-class-codes


== 填写设备ID ==

<pre>echo 0x05F9 > /sys/kernel/config/usb_gadget/my_gadget/idVendor
echo 0x1234 > /sys/kernel/config/usb_gadget/my_gadget/idProduct</pre>
== 填写设备字符串描述 ==

参考： [[USB Gadget#附注语言id|语言ID]]

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409
echo "My Vendor" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/manufacturer
echo "My Product" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/product
echo "123456789" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/serialnumber</pre>
== 创建功能 ==

gadget子系统支持非常多的usb功能，也可以使用用户空间的functionfs和主机进行通信。这里演示大容量存储和RNDIS网络

格式：<pre>functions/%FUNC%.%NAME%</pre>

{| class="wikitable"
|-
! 符号
! 描述
|-
| FUNC
| 要使用的功能名称
|-
| NAME
| 创建的自定义名字
|}

==== 创建并配置大容量存储 ====

创建功能：

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img</pre>
选择设备或者镜像

<pre>echo /mnt/a_virtual_disk.img > /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img/lun.0/file
echo 1 > /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img/lun.0/removable</pre>
Linux内核的mass_storage支持多个lun，默认会创建lun.0，也可以手动创建其它lun以映射多个设备（不推荐，多lun的大容量存储兼容性不好，建议可以使用多个大容量存储功能替代）

lun.X下有以下内容，可以根据情况填写

{| class="wikitable"
|-
! 文件名
! 描述
|-
| cdrom
| 指示是否映射为虚拟光盘(0:普通磁盘，1:虚拟光盘)
|-
| file
| 映射的后端文件或设备绝对路径
|-
| forced_eject
| 写入这个文件将导致lun被强制分离
|-
| inquiry_string
| 设置显示在主机的设备名称
|-
| nofua
| 指示是否使用SCSI FUA标志
|-
| removable
| 指示是否可移除设备(0:不可移除设备，1:可移除设备)
|-
| ro
| 指示是否只读设备(0:可读写，1:只读)
|}


==== 创建并配置RNDIS ====

创建功能：

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/functions/rndis.my_net</pre>
初始化成功后，将会创建一个usb0网卡，对端连接到主机

==== 其它功能列表 ====

{| class="wikitable"
|-
! 功能
! 描述
|-
| mass_storage
| 大容量存储(BOT协议)
|-
| rndis
| RNDIS虚拟网卡
|-
| ffs
| FunctionFS 用户空间设备
|-
| acm
| CDC ACM虚拟串口
|-
| obex
| CDC OBEX对象交换
|-
| ecm
| CDC ECM虚拟网卡
|-
| eem
| CDC EEM虚拟网卡
|-
| ncm
| CDC NCM虚拟网卡
|-
| geth
| CDC Subset虚拟网卡
|-
| gser
| USB串口
|-
| hid
| HID 人类输入设备（鼠标/键盘等）
|-
| printer
| 模拟打印机
|-
| tcm
| SCSI目标映射大容量存储 (UASP协议)
|-
| uac1
| USB音频1.0
|-
| uac2
| USB音频2.0
|-
| uvc
| USB视频(摄像头)
|}

使用前，可以使用<code>modprobe usbfunc:功能</code>来加载所需模块。如：

<pre>modprobe usbfunc:mass_storage</pre>
== 创建配置 ==

创建完功能后，还需要将其链接到配置文件。默认不会创建任何配置文件，需要手动创建

=== 创建一个配置 ===

格式：<code>configs/%NAME%.%INDEX%</code>

{| class="wikitable"
|-
! 符号
! 描述
|-
| NAME
| 创建的自定义名字
|-
| INDEX
| 配置文件的序号必须大于1，且不能重复
|}

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/configs/a.1</pre>
=== 链接功能到配置 ===

<pre>ln -s /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/my_func.1
ln -s /sys/kernel/config/usb_gadget/my_gadget/functions/rndis.my_net /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/my_func.2</pre>
=== 填写字符串描述 ===

参考： [[USB Gadget#附注语言id|语言ID]]

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/strings/0x0409
echo "MY MASS + RNDIS" > /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/strings/0x0409/configuration</pre>
== 启动设备 ==

在<code>/sys/class/udc</code>中有可用的USB设备器列表，将其名字写入UDC即可启动gadget

=== 查看可用 ===

<pre>ls -l /sys/class/udc/</pre>
<pre>ffff0000.usb</pre>
=== 启动gadget ===

<pre>echo ffff0000.usb > /sys/kernel/config/usb_gadget/my_gadget/UDC</pre>
此时，主机会成功发现设备

<pre class="">[12345.000000] usb 1-1.1: new high-speed USB device number 1 using xhci_hcd
[12345.000015] usb 1-1.1: New USB device found, idVendor=05f9, idProduct=1234, bcdDevice= 6.08
[12345.000030] usb 1-1.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[12345.000045] usb 1-1.1: Product: My Product
[12345.000060] usb 1-1.1: Manufacturer: My Vendor
[12345.000075] usb 1-1.1: SerialNumber: 123456789
[12345.000100] usb-storage 1-1.1:1.0: USB Mass Storage device detected
[12345.000115] scsi host0: usb-storage 1-1.1:1.0
[12345.000130] scsi 0:0:0:0: Direct-Access Linux UMS disk 0 ffff PQ: 0 ANSI: 2
[12345.000145] sd 0:0:0:0: Attached scsi generic sg0 type 0
[12345.000160] sd 0:0:0:0: [sda] 61071360 512-byte logical blocks: (31.3 GB/29.1 GiB)
[12345.000175] sd 0:0:0:0: [sda] Write Protect is off
[12345.000190] sd 0:0:0:0: [sda] Mode Sense: 0f 00 00 00
[12345.000205] sd 0:0:0:0: [sda] Write cache: enabled, read cache: enabled, doesn't support DPO or FUA
[12345.000220] sda: sda1
[12345.000235] sd 0:0:0:0: [sda] Attached SCSI removable disk
[12345.000300] rndis_host 1-1.1:1.1 usb0: register 'rndis_host' at usb-0000:01:00.0-1.1, RNDIS device, 1a:2b:3c:4d:5e:6f
[12345.000315] rndis_host 1-1.1:1.1 enp1s0u1u1: renamed from usb0</pre>
=== 停止gadget ===

如果想要停止gadget，则直接写空即可

<pre>echo > /sys/kernel/config/usb_gadget/my_gadget/UDC</pre>

== 附注：语言ID ==

{| class="wikitable"
|-
! ID
! 标识符
! 语言
|-
| 0x0409
| en-us
| 英语(美国)
|-
| 0x0804
| zh-cn
| 中文(中国)
|}

关于语言ID: https://learn.microsoft.com/en-us/windows/win32/intl/language-identifiers

USB Gadget

2024-03-20T04:06:32Z

BigfootACA：

= Linux USB Gadget =

== 概述 ==

Linux在configfs中提供了usb_gadget用于支持USB设备模式。[[关于USB.md|关于USB]]

== 准备configfs ==

在默认情况下，系统会自动挂载configfs，根据发行版不同，可能会挂在到不同的目录：

{| class="wikitable"
|-
! 系统
! 目录
|-
| Android
| /config
|-
| GNU/Linux
| /sys/kernel/config
|}

也可以通过以下命令来查看

<pre>mount | grep configfs</pre>
<pre class="">configfs on /sys/kernel/config type configfs (rw,nosuid,nodev,noexec,relatime)</pre>
如果没有挂载，也可以通过以下命令挂载

<pre>mount -t configfs configfs /sys/kernel/config</pre>
注：usb_gadget的configfs接口由模块<code>libcomposite</code>提供

== 创建gadget ==

简单的使用mkdir即可创建一个gadget。如要创建一个名为my_gadget：

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget</pre>
创建完成后，configfs会自动添加虚拟文件，以下是参照表

{| class="wikitable"
|-
! 文件/文件夹名称
! 描述
|-
| bcdDevice
| 设备版本，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| bcdUSB
| USB的协议版本，使用带0x前缀的四个十六进制数字（0x0200，0x0301）
|-
| idProduct
| USB设备的产品ID，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| idVendor
| USB设备的制造商ID，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| bDeviceClass
| USB设备识别的设备类，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bDeviceSubClass
| USB设备识别的设备子类，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bDeviceProtocol
| USB设备识别的设备协议，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bMaxPacketSize0
| 单次包最大传输大小
|-
| configs/
| gadget的配置文件
|-
| functions/
| gadget的子功能
|-
| strings/
| 向主机上报的设备名称
|-
| max_speed
| 支持的最大速度
|-
| os_desc
| 向主机展示的操作系统相关的描述
|-
| UDC
| 使用的USB设备控制器，可以在<code>/sys/class/udc</code>中选择
|}

Vendor ID、Product ID列表：http://www.linux-usb.org/usb.ids

Class、SubClass、Protocol列表：https://www.usb.org/defined-class-codes


== 填写设备ID ==

<pre>echo 0x05F9 > /sys/kernel/config/usb_gadget/my_gadget/idVendor
echo 0x1234 > /sys/kernel/config/usb_gadget/my_gadget/idProduct</pre>
== 填写设备字符串描述 ==

参考： [[#附注语言id|语言ID]]

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409
echo "My Vendor" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/manufacturer
echo "My Product" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/product
echo "123456789" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/serialnumber</pre>
== 创建功能 ==

gadget子系统支持非常多的usb功能，也可以使用用户空间的functionfs和主机进行通信。这里演示大容量存储和RNDIS网络

格式：<pre>functions/%FUNC%.%NAME%</pre>

{| class="wikitable"
|-
! 符号
! 描述
|-
| FUNC
| 要使用的功能名称
|-
| NAME
| 创建的自定义名字
|}

==== 创建并配置大容量存储 ====

创建功能：

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img</pre>
选择设备或者镜像

<pre>echo /mnt/a_virtual_disk.img > /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img/lun.0/file
echo 1 > /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img/lun.0/removable</pre>
Linux内核的mass_storage支持多个lun，默认会创建lun.0，也可以手动创建其它lun以映射多个设备（不推荐，多lun的大容量存储兼容性不好，建议可以使用多个大容量存储功能替代）

lun.X下有以下内容，可以根据情况填写

{| class="wikitable"
|-
! 文件名
! 描述
|-
| cdrom
| 指示是否映射为虚拟光盘(0:普通磁盘，1:虚拟光盘)
|-
| file
| 映射的后端文件或设备绝对路径
|-
| forced_eject
| 写入这个文件将导致lun被强制分离
|-
| inquiry_string
| 设置显示在主机的设备名称
|-
| nofua
| 指示是否使用SCSI FUA标志
|-
| removable
| 指示是否可移除设备(0:不可移除设备，1:可移除设备)
|-
| ro
| 指示是否只读设备(0:可读写，1:只读)
|}


==== 创建并配置RNDIS ====

创建功能：

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/functions/rndis.my_net</pre>
初始化成功后，将会创建一个usb0网卡，对端连接到主机

==== 其它功能列表 ====

{| class="wikitable"
|-
! 功能
! 描述
|-
| mass_storage
| 大容量存储(BOT协议)
|-
| rndis
| RNDIS虚拟网卡
|-
| ffs
| FunctionFS 用户空间设备
|-
| acm
| CDC ACM虚拟串口
|-
| obex
| CDC OBEX对象交换
|-
| ecm
| CDC ECM虚拟网卡
|-
| eem
| CDC EEM虚拟网卡
|-
| ncm
| CDC NCM虚拟网卡
|-
| geth
| CDC Subset虚拟网卡
|-
| gser
| USB串口
|-
| hid
| HID 人类输入设备（鼠标/键盘等）
|-
| printer
| 模拟打印机
|-
| tcm
| SCSI目标映射大容量存储 (UASP协议)
|-
| uac1
| USB音频1.0
|-
| uac2
| USB音频2.0
|-
| uvc
| USB视频(摄像头)
|}

使用前，可以使用<code>modprobe usbfunc:功能</code>来加载所需模块。如：

<pre>modprobe usbfunc:mass_storage</pre>
== 创建配置 ==

创建完功能后，还需要将其链接到配置文件。默认不会创建任何配置文件，需要手动创建

=== 创建一个配置 ===

格式：<code>configs/%NAME%.%INDEX%</code>

{| class="wikitable"
|-
! 符号
! 描述
|-
| NAME
| 创建的自定义名字
|-
| INDEX
| 配置文件的序号必须大于1，且不能重复
|}

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/configs/a.1</pre>
=== 链接功能到配置 ===

<pre>ln -s /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/my_func.1
ln -s /sys/kernel/config/usb_gadget/my_gadget/functions/rndis.my_net /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/my_func.2</pre>
=== 填写字符串描述 ===

参考： [[#附注语言id|语言ID]]

<pre>mkdir /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/strings/0x0409
echo "MY MASS + RNDIS" > /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/strings/0x0409/configuration</pre>
== 启动设备 ==

在<code>/sys/class/udc</code>中有可用的USB设备器列表，将其名字写入UDC即可启动gadget

=== 查看可用 ===

<pre>ls -l /sys/class/udc/</pre>
<pre>ffff0000.usb</pre>
=== 启动gadget ===

<pre>echo ffff0000.usb > /sys/kernel/config/usb_gadget/my_gadget/UDC</pre>
此时，主机会成功发现设备

<pre class="">[12345.000000] usb 1-1.1: new high-speed USB device number 1 using xhci_hcd
[12345.000015] usb 1-1.1: New USB device found, idVendor=05f9, idProduct=1234, bcdDevice= 6.08
[12345.000030] usb 1-1.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[12345.000045] usb 1-1.1: Product: My Product
[12345.000060] usb 1-1.1: Manufacturer: My Vendor
[12345.000075] usb 1-1.1: SerialNumber: 123456789
[12345.000100] usb-storage 1-1.1:1.0: USB Mass Storage device detected
[12345.000115] scsi host0: usb-storage 1-1.1:1.0
[12345.000130] scsi 0:0:0:0: Direct-Access Linux UMS disk 0 ffff PQ: 0 ANSI: 2
[12345.000145] sd 0:0:0:0: Attached scsi generic sg0 type 0
[12345.000160] sd 0:0:0:0: [sda] 61071360 512-byte logical blocks: (31.3 GB/29.1 GiB)
[12345.000175] sd 0:0:0:0: [sda] Write Protect is off
[12345.000190] sd 0:0:0:0: [sda] Mode Sense: 0f 00 00 00
[12345.000205] sd 0:0:0:0: [sda] Write cache: enabled, read cache: enabled, doesn't support DPO or FUA
[12345.000220] sda: sda1
[12345.000235] sd 0:0:0:0: [sda] Attached SCSI removable disk
[12345.000300] rndis_host 1-1.1:1.1 usb0: register 'rndis_host' at usb-0000:01:00.0-1.1, RNDIS device, 1a:2b:3c:4d:5e:6f
[12345.000315] rndis_host 1-1.1:1.1 enp1s0u1u1: renamed from usb0</pre>
=== 停止gadget ===

如果想要停止gadget，则直接写空即可

<pre>echo > /sys/kernel/config/usb_gadget/my_gadget/UDC</pre>

== 附注：语言ID ==

{| class="wikitable"
|-
! ID
! 标识符
! 语言
|-
| 0x0409
| en-us
| 英语(美国)
|-
| 0x0804
| zh-cn
| 中文(中国)
|}

关于语言ID: https://learn.microsoft.com/en-us/windows/win32/intl/language-identifiers

USB Gadget

2024-03-20T04:02:00Z

BigfootACA：创建页面，内容为“ = Linux USB Gadget = == 概述 == Linux在configfs中提供了usb_gadget用于支持USB设备模式。关于USB == 准备configfs == 在默认情况下，系统会自动挂载configfs，根据发行版不同，可能会挂在到不同的目录： {| class="wikitable" |- ! 系统 ! 目录 |- | Android | /config |- | GNU/Linux | /sys/kernel/config |} 也可以通过以下命令来查看 <code>mount | gre…”

= Linux USB Gadget =

== 概述 ==

Linux在configfs中提供了usb_gadget用于支持USB设备模式。[[关于USB.md|关于USB]]

== 准备configfs ==

在默认情况下，系统会自动挂载configfs，根据发行版不同，可能会挂在到不同的目录：

{| class="wikitable"
|-
! 系统
! 目录
|-
| Android
| /config
|-
| GNU/Linux
| /sys/kernel/config
|}

也可以通过以下命令来查看

<code>mount | grep configfs</code>
<pre class="">configfs on /sys/kernel/config type configfs (rw,nosuid,nodev,noexec,relatime)</pre>
如果没有挂载，也可以通过以下命令挂载

<code>mount -t configfs configfs /sys/kernel/config</code>
注：usb_gadget的configfs接口由模块<code>libcomposite</code>提供

== 创建gadget ==

简单的使用mkdir即可创建一个gadget。如要创建一个名为my_gadget：

<code>mkdir /sys/kernel/config/usb_gadget/my_gadget</code>
创建完成后，configfs会自动添加虚拟文件，以下是参照表

{| class="wikitable"
|-
! 文件/文件夹名称
! 描述
|-
| bcdDevice
| 设备版本，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| bcdUSB
| USB的协议版本，使用带0x前缀的四个十六进制数字（0x0200，0x0301）
|-
| idProduct
| USB设备的产品ID，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| idVendor
| USB设备的制造商ID，使用带0x前缀的四个十六进制数字（0x1234，0x89AB）
|-
| bDeviceClass
| USB设备识别的设备类，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bDeviceSubClass
| USB设备识别的设备子类，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bDeviceProtocol
| USB设备识别的设备协议，使用带0x前缀的两个十六进制数字（0x34，0x9A）
|-
| bMaxPacketSize0
| 单次包最大传输大小
|-
| configs/
| gadget的配置文件
|-
| functions/
| gadget的子功能
|-
| strings/
| 向主机上报的设备名称
|-
| max_speed
| 支持的最大速度
|-
| os_desc
| 向主机展示的操作系统相关的描述
|-
| UDC
| 使用的USB设备控制器，可以在<code>/sys/class/udc</code>中选择
|}

Vendor ID、Product ID列表：http://www.linux-usb.org/usb.ids

Class、SubClass、Protocol列表：https://www.usb.org/defined-class-codes


== 填写设备ID ==

<code>echo 0x05F9 > /sys/kernel/config/usb_gadget/my_gadget/idVendor
echo 0x1234 > /sys/kernel/config/usb_gadget/my_gadget/idProduct</code>
== 填写设备字符串描述 ==

参考： [[#附注语言id|语言ID]]

<code>mkdir /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409
echo "My Vendor" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/manufacturer
echo "My Product" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/product
echo "123456789" > /sys/kernel/config/usb_gadget/my_gadget/strings/0x0409/serialnumber</code>
== 创建功能 ==

gadget子系统支持非常多的usb功能，也可以使用用户空间的functionfs和主机进行通信。这里演示大容量存储和RNDIS网络

格式：<code>functions/%FUNC%.%NAME%</code>

{| class="wikitable"
|-
! 符号
! 描述
|-
| FUNC
| 要使用的功能名称
|-
| NAME
| 创建的自定义名字
|}

==== 创建并配置大容量存储 ====

创建功能：

<code>mkdir /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img</code>
选择设备或者镜像

<code>echo /mnt/a_virtual_disk.img > /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img/lun.0/file
echo 1 > /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img/lun.0/removable</code>
Linux内核的mass_storage支持多个lun，默认会创建lun.0，也可以手动创建其它lun以映射多个设备（不推荐，多lun的大容量存储兼容性不好，建议可以使用多个大容量存储功能替代）

lun.X下有以下内容，可以根据情况填写

{| class="wikitable"
|-
! 文件名
! 描述
|-
| cdrom
| 指示是否映射为虚拟光盘(0:普通磁盘，1:虚拟光盘)
|-
| file
| 映射的后端文件或设备绝对路径
|-
| forced_eject
| 写入这个文件将导致lun被强制分离
|-
| inquiry_string
| 设置显示在主机的设备名称
|-
| nofua
| 指示是否使用SCSI FUA标志
|-
| removable
| 指示是否可移除设备(0:不可移除设备，1:可移除设备)
|-
| ro
| 指示是否只读设备(0:可读写，1:只读)
|}


==== 创建并配置RNDIS ====

创建功能：

<code>mkdir /sys/kernel/config/usb_gadget/my_gadget/functions/rndis.my_net</code>
初始化成功后，将会创建一个usb0网卡，对端连接到主机

==== 其它功能列表 ====

{| class="wikitable"
|-
! 功能
! 描述
|-
| mass_storage
| 大容量存储(BOT协议)
|-
| rndis
| RNDIS虚拟网卡
|-
| ffs
| FunctionFS 用户空间设备
|-
| acm
| CDC ACM虚拟串口
|-
| obex
| CDC OBEX对象交换
|-
| ecm
| CDC ECM虚拟网卡
|-
| eem
| CDC EEM虚拟网卡
|-
| ncm
| CDC NCM虚拟网卡
|-
| geth
| CDC Subset虚拟网卡
|-
| gser
| USB串口
|-
| hid
| HID 人类输入设备（鼠标/键盘等）
|-
| printer
| 模拟打印机
|-
| tcm
| SCSI目标映射大容量存储 (UASP协议)
|-
| uac1
| USB音频1.0
|-
| uac2
| USB音频2.0
|-
| uvc
| USB视频(摄像头)
|}

使用前，可以使用<code>modprobe usbfunc:功能</code>来加载所需模块。如：

<code>modprobe usbfunc:mass_storage</code>
== 创建配置 ==

创建完功能后，还需要将其链接到配置文件。默认不会创建任何配置文件，需要手动创建

=== 创建一个配置 ===

格式：<code>configs/%NAME%.%INDEX%</code>

{| class="wikitable"
|-
! 符号
! 描述
|-
| NAME
| 创建的自定义名字
|-
| INDEX
| 配置文件的序号必须大于1，且不能重复
|}

<code>mkdir /sys/kernel/config/usb_gadget/my_gadget/configs/a.1</code>
=== 链接功能到配置 ===

<code>ln -s /sys/kernel/config/usb_gadget/my_gadget/functions/mass_storage.my_img /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/my_func.1
ln -s /sys/kernel/config/usb_gadget/my_gadget/functions/rndis.my_net /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/my_func.2</code>
=== 填写字符串描述 ===

参考： [[#附注语言id|语言ID]]

<code>mkdir /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/strings/0x0409
echo "MY MASS + RNDIS" > /sys/kernel/config/usb_gadget/my_gadget/configs/a.1/strings/0x0409/configuration</code>
== 启动设备 ==

在<code>/sys/class/udc</code>中有可用的USB设备器列表，将其名字写入UDC即可启动gadget

=== 查看可用 ===

<code>ls -l /sys/class/udc/</code>
<pre class="">ffff0000.usb</pre>
=== 启动gadget ===

<code>echo ffff0000.usb > /sys/kernel/config/usb_gadget/my_gadget/UDC</code>
此时，主机会成功发现设备

<pre class="">[12345.000000] usb 1-1.1: new high-speed USB device number 1 using xhci_hcd
[12345.000015] usb 1-1.1: New USB device found, idVendor=05f9, idProduct=1234, bcdDevice= 6.08
[12345.000030] usb 1-1.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[12345.000045] usb 1-1.1: Product: My Product
[12345.000060] usb 1-1.1: Manufacturer: My Vendor
[12345.000075] usb 1-1.1: SerialNumber: 123456789
[12345.000100] usb-storage 1-1.1:1.0: USB Mass Storage device detected
[12345.000115] scsi host0: usb-storage 1-1.1:1.0
[12345.000130] scsi 0:0:0:0: Direct-Access Linux UMS disk 0 ffff PQ: 0 ANSI: 2
[12345.000145] sd 0:0:0:0: Attached scsi generic sg0 type 0
[12345.000160] sd 0:0:0:0: [sda] 61071360 512-byte logical blocks: (31.3 GB/29.1 GiB)
[12345.000175] sd 0:0:0:0: [sda] Write Protect is off
[12345.000190] sd 0:0:0:0: [sda] Mode Sense: 0f 00 00 00
[12345.000205] sd 0:0:0:0: [sda] Write cache: enabled, read cache: enabled, doesn't support DPO or FUA
[12345.000220] sda: sda1
[12345.000235] sd 0:0:0:0: [sda] Attached SCSI removable disk
[12345.000300] rndis_host 1-1.1:1.1 usb0: register 'rndis_host' at usb-0000:01:00.0-1.1, RNDIS device, 1a:2b:3c:4d:5e:6f
[12345.000315] rndis_host 1-1.1:1.1 enp1s0u1u1: renamed from usb0</pre>
=== 停止gadget ===

如果想要停止gadget，则直接写空即可

<code>echo > /sys/kernel/config/usb_gadget/my_gadget/UDC</code>

== 附注：语言ID ==

{| class="wikitable"
|-
! ID
! 标识符
! 语言
|-
| 0x0409
| en-us
| 英语(美国)
|-
| 0x0804
| zh-cn
| 中文(中国)
|}

关于语言ID: https://learn.microsoft.com/en-us/windows/win32/intl/language-identifiers

关于USB

2024-03-20T03:54:27Z

BigfootACA：创建页面，内容为“ = USB = == USB简述 == 众所周知，USB分为Host(主机)和Device(设备)两种模式，像普通的PC通常工作在主机端，U盘、鼠标等设备则工作在设备端。在移动设备上则有OTG(On The Go)，可以根据需要选择作为主机端或者设备端。 USB: Universal Serial Bus == USB版本 == === USB 1.0 === USB 1.0至USB 2.…”

= USB =


== USB简述 ==

众所周知，USB分为Host(主机)和Device(设备)两种模式，像普通的PC通常工作在主机端，U盘、鼠标等设备则工作在设备端。在移动设备上则有OTG(On The Go)，可以根据需要选择作为主机端或者设备端。

USB: Universal Serial Bus


== USB版本 ==


=== USB 1.0 ===

USB 1.0至USB 2.0具有一对差分线对(半双工 D+, D-)

最大速度1.5Mbit/s，标准名称为Low-Speed(LS)，常用控制器ohci

常见于：鼠标/键盘/串口转换器/低速单片机


=== USB 1.1 ===

最大速度12Mbit/s，标准名称为Full-Speed(FS)，常用控制器ohci

常见于：鼠标/键盘/串口转换器/低速单片机


=== USB 2.0 ===

最大速度480Mbit/s，标准名称为High-Speed(HS)，常用控制器ehci

这个版本是最为常见的USB版本


=== USB 3.0 ===

最大速度5Gbit/s，标准名称为Super-Speed(SS)，常用控制器xhci

常见于：高速U盘/移动硬盘/手机等

注：从这个版本开始，USB 2及以前的差分信号线和USB 3的差分信号线分开，在物理上为两个USB控制器，D+和D-用于向下兼容USB 2及以前的版本，另外两对差分信号线则专门用于传输USB 3


=== USB 3.1 ===

最大速度10Gbit/s，标准名称为Super-Speed+(SS+)，常用控制器xhci

分为Gen 2x1、Gen 1x2两种


=== USB 3.2 ===

最大速度40Gbit/s

基于雷电3(Thunderbolt 3)协议


=== USB 4.0 ===


=== 附注：USB 3 Gen 1x1、Gen 1x2 ===

具有两对差分线对 (全双工 SSTX+, SSTX-, SSRX+, SSRX-)

Gen 1x1 速度为5Gbit

Gen 1x2 速度为10Gbit


=== 附注：USB 3 Gen 2x1、Gen 2x2 ===

具有四对差分线对 (全双工 SSTX1+, SSTX1-, SSRX1+, SSRX1-, SSTX2+, SSTX2-, SSRX2+, SSRX2-)

Gen 2x1 速度为10Gbit

Gen 2x2 速度为20Gbit

不同于Gen 1x1、Gen 1x2，这个版本只支持USB Type-C(引脚数量较多)


== 常见的USB接口 ==


=== USB Type-A ===

[[File:https://bkimg.cdn.bcebos.com/pic/7ab514d196f4eee3572c84fb|thumb|none]]

这个接口常见于大部分PC和设备，分为公口和母口。标准实现的Type-A同时只支持主机端(母口)或者设备端(公口)。


==== USB 1.0/1.1/2.0 引脚定义 ====

{| class="wikitable"
|-
! 引脚
! 功能
|-
| VBUS
| 电源正(红)
|-
| D-
| USB差分数据负(白)
|-
| D+
| USB差分数据正(绿)
|-
| GND
| 电源地(黑)
|}


=== USB 3.0/3.1 额外引脚定义 ===

{| class="wikitable"
|-
! 引脚
! 功能
|-
| SSTX+
| USB 3 差分发送正
|-
| SSTX−
| USB 3 差分发送负
|-
| GND
| 信号地
|-
| SSRX+
| USB 3 差分接收正
|-
| SSRX−
| USB 3 差分接收负
|}


=== USB Micro-B ===

[[File:https://bkimg.cdn.bcebos.com/pic/63d9f2d3572c11df988d7c4e622762d0f703c27b|thumb|none]]

可以在较旧的可移动电子设备找到，支持OTG（通过ID脚）

==== 引脚定义 ====

{| class="wikitable"
|-
! 引脚
! 功能
|-
| VBUS
| 电源正
|-
| D-
| USB差分数据负
|-
| D+
| USB差分数据正
|-
| ID
| 模式检测
|-
| GND
| 电源地
|}


=== USB Type-C ===

[[File:https://bkimg.cdn.bcebos.com/pic/a6efce1b9d16fdfa211d01e4bb8f8c5494ee7b43|thumb|none]]


==== 引脚定义 ====

{| class="wikitable"
|-
! 功能A
! 引脚A
! 引脚B
! 功能B
|-
| 接地
| GND
| GND
| 接地
|-
| USB 3 差分1发送正
| SSTX1+
| SSRX1+
| USB 3 差分1接收正
|-
| USB 3 差分1发送负
| SSTX1-
| SSRX1-
| USB 3 差分1接收负
|-
| 电源正
| VBUS
| VBUS
| 电源正
|-
| 配置通道1
| CC1
| SBU2
| 边带使用2
|-
| USB差分数据正
| D+
| D-
| USB差分数据负
|-
| USB差分数据负
| D-
| D+
| USB差分数据正
|-
| 边带使用1
| SBU1
| CC2
| 配置通道2
|-
| 电源正
| VBUS
| VBUS
| 电源正
|-
| USB 3 差分2接收负
| SSRX2-
| SSTX2-
| USB 3 差分2发送负
|-
| USB 3 差分2接收正
| SSRX2+
| SSTX2+
| USB 3 差分2发送正
|-
| 接地
| GND
| GND
| 接地
|}

== 其它可参考资料 ==

https://en.wikipedia.org/wiki/USB

https://en.wikipedia.org/wiki/USB-C

https://en.wikipedia.org/wiki/USB_On-The-Go

https://en.wikipedia.org/wiki/USB_hardware

ARM-v8a异常等级

2024-02-20T10:58:48Z

BigfootACA：创建页面，内容为“{| class="wikitable" |+ !等级 !值 !长名称 !描述 !调用指令 |- |EL3 |0xC/12 |Secure Monitor |固件或安全监视器 |SMC |- |EL2 |0x8/8 |Hyper Visor |虚拟化管理器 |HVC |- |EL1 |0x4/4 |Super Visor |操作系统内核 |SVC |- |EL0 | - |Application |用户程序 | - |} 每个异常等级都拥有自己的MMU页表，内存可隔离，高等级的环境可以访问低等级的寄存器和内存当程序执行调用指令时，会进入目标等…”

{| class="wikitable"
|+
!等级
!值
!长名称
!描述
!调用指令
|-
|EL3
|0xC/12
|Secure Monitor
|固件或安全监视器
|SMC
|-
|EL2
|0x8/8
|Hyper Visor
|虚拟化管理器
|HVC
|-
|EL1
|0x4/4
|Super Visor
|操作系统内核
|SVC
|-
|EL0
| -
|Application
|用户程序
| -
|}
每个异常等级都拥有自己的MMU页表，内存可隔离，高等级的环境可以访问低等级的寄存器和内存

当程序执行调用指令时，会进入目标等级先前设置的向量表（VBAR_ELX）以处理调用

当程序进行跨级调用时，直属上级可以截获并处理调用，并将返回地址设置在ELR寄存器。触发ERET时，将回到低等级的ELR处继续执行

Linux操作系统内核的KVM需要Linux内核以EL2等级进行启动，vhe将会在EL2下保持运行成为Hypervisor

==== 高通平台启动示意图 ====
[[文件:20210127170824367.png|居中]]

文件:20210127170824367.png

2024-02-20T10:54:47Z

BigfootACA：

Fastboot协议

2024-02-20T10:15:19Z

BigfootACA：简单添加Fastboot协议描述

大部分安卓手机的引导程序实现了一个名为Fastboot的协议，可以通过USB向设备刷写/启动操作系统，或者读取一些信息。常见的BL锁指的就是fastboot和avb(Android Verified Boot安卓验证启动）是否强制验证签名。

==== 设备识别ID ====
USB Class: 0xFF, SubClass: 0x42, Protocol: 0x03

DeviceInterfaceGUIDs: {F72FE0D4-CBCB-407D-8814-9ED673D0DD6B}

Windows: USB\MS_COMP_WINUSB

Windows: USB\Class_ff&SubClass_42&Prot_03

==== 关于驱动 ====
Fastboot不需要驱动。

在Linux下，fastboot工具直接读写/dev/bus/usb/XXX/XXX设备进行通信

在Windows下，fastboot工具通过WinUSB（对于裸USB设备的包装，Windows不允许直接读写USB设备，此驱动系统内置）和设备进行通信

WINUSB: C:\Windows\INF\winusb.INF C:\Windows\System32\drivers\winusb.sys

==== 主机端命令请求格式： ====

* getvar:%s

该命令用于从设备读取一个变量

getvar:current-slot

%s：任意字符串（变量名称）

* download:%08x

该命令表示即将向设备的缓冲区发送指定大小的数据用于刷写/启动等等

%08x: 8字长的十六进制数（数据大小）

小写x表示数字以小写十六进制表示，8表示不满8字长则填充，0表示使用0填充

示例：download:0000A000

* flash:%s

将缓冲区中的数据刷入指定分区

%s：任意字符串（分区名称）

* reboot

重启设备

==== 设备端响应格式 ====

* OKAY / OKAY%s

表示命令已成功执行，并附带信息

%s：任意字符串（状态信息）

示例：OKAY

示例：OKAYyes

示例：OKAYcommand done

* INFO%s

命令执行中上报状态信息

%s：任意字符串（状态信息）

示例：INFOflashing

* FAIL / FAIL%s

表示命令执行失败，并附带信息

%s：任意字符串（状态信息）

示例：FAIL

示例：FAILunknown command

示例：FAILwrite failed

* DATA%08x

表示设备已准备好接收主机端发来的数据（通常由download:%08x发起）

%08x: 8字长的十六进制数（数据大小）

小写x表示数字以小写十六进制表示，8表示不满8字长则填充，0表示使用0填充

示例：DATA0000A000

==== 示例命令分析 ====

* fastboot getvar kernel

主机：getvar:kernel

设备：OKAYuefi

* fastboot flash boot boot.img

主机：download:00100000

设备：DATA00100000

主机：（发送boot.img的内容）

设备：OKAY

主机：flash:boot

设备：INFOflashing...

设备：OKAY

==== 其它注意事项 ====

* 向设备发送数据(download)时，数据不能大于max-download-size变量（缓冲区大小）的值。

当需要刷写的数据超过缓冲区大小时，则使用sparse对文件分段处理。

''（待补充...）''

==== Fastboot实现 ====
Qualcomm ABL: https://git.codelinaro.org/clo/la/abl/tianocore/edk2/-/tree/uefi.lnx.4.0.r37-rel/QcomModulePkg/Library/FastbootLib

lk2nd: https://github.com/msm8916-mainline/lk2nd/blob/master/app/aboot/fastboot.c

U-Boot: https://github.com/u-boot/u-boot/tree/master/drivers/fastboot

Userspace Fastbootd: https://android.googlesource.com/platform/system/core/+/refs/heads/main/fastboot/device/

linux-simple-mass-storage: https://github.com/BigfootACA/linux-simple-mass-storage/tree/master/src/fastboot

==== 其它参考文档 ====
https://android.googlesource.com/platform/system/core/+/master/fastboot/README.md