michaelh/zephyr
1
0
Fork 0
Code Releases Activity

subsys: usb: Set Zephyr project USB Vendor and Product IDs

Browse source 
Document USB Vendor and Product IDs and their intended usage.
Set the Vendor and Product IDs and define the USB bcdDevice
Device Descriptor Device Release Number to be the binary
coded decimal representation of the Zephyr major and minor
kernel version number.

Signed-off-by: Patrik Flykt <patrik.flykt@intel.com>
This commit is contained in:
Patrik Flykt 2018-01-12 09:30:34 +02:00 • committed by Anas Nashif
commit 010fb40b95
4 changed files with 31 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/subsystems/usb/usb.rst
View file

@ -1,3 +1,18 @@
USB Vendor and Product identifiers
##################################
The USB Vendor ID for the Zephyr project is 0x2FE3. The default USB Product
ID for the Zephyr project is 0x100. The USB bcdDevice Device Release Number
represents the Zephyr kernel major and minor versions as a binary coded
decimal value. When a vendor integrates the Zephyr USB subsystem into a
product, the vendor must use the USB Vendor and Product ID assigned to them.
A vendor integrating the Zephyr USB subsystem in a product must not use the
Vendor ID of the Zephyr project.
The USB maintainer, if one is assigned, or otherwise the Zephyr Technical
Steering Committee, may allocate other USB Product IDs based on well-motivated
and documented requests.
USB device stack USB device stack
################ ################

7
include/usb/usb_common.h
View file

@ -39,9 +39,13 @@
* This file contains useful constants and macros for the USB applications. * This file contains useful constants and macros for the USB applications.
*/ */
#include <version.h>
#ifndef USB_COMMON_H_ #ifndef USB_COMMON_H_
#define USB_COMMON_H_ #define USB_COMMON_H_
#define BCD(x) ((((x) / 10) << 4) | ((x) / 10))
/* Descriptor size in bytes */ /* Descriptor size in bytes */
#define USB_DEVICE_DESC_SIZE 18 #define USB_DEVICE_DESC_SIZE 18
#define USB_CONFIGURATION_DESC_SIZE 9 #define USB_CONFIGURATION_DESC_SIZE 9
@ -72,7 +76,8 @@
/* Set USB version to 2.1 so that the host will request the BOS descriptor */ /* Set USB version to 2.1 so that the host will request the BOS descriptor */
#define USB_2_1 0x0210 #define USB_2_1 0x0210
#define BCDDEVICE_RELNUM 0x0100 #define BCDDEVICE_RELNUM (BCD(KERNEL_VERSION_MAJOR) << 8 | \
BCD(KERNEL_VERSION_MINOR))
/* 100mA max power, per 2mA units */ /* 100mA max power, per 2mA units */
/* USB 1.1 spec indicates 100mA(max) per unit load, up to 5 loads */ /* USB 1.1 spec indicates 100mA(max) per unit load, up to 5 loads */

15
subsys/usb/CMakeLists.txt
View file

@ -13,16 +13,17 @@ if(CONFIG_USB_COMPOSITE_DEVICE)
) )
endif() endif()
if(CONFIG_USB_DEVICE_VID EQUAL 0xDEAD) if(CONFIG_USB_DEVICE_VID EQUAL 0x2FE3)
message(WARNING message(WARNING
"CONFIG_USB_DEVICE_VID has default test value 0xDEAD. "CONFIG_USB_DEVICE_VID has default value 0x2FE3.
This value is only for testing and MUST be configured for USB products." This value is only for testing and MUST be configured for USB products."
) )
endif()
if(CONFIG_USB_DEVICE_PID EQUAL 0xBEEF) if(CONFIG_USB_DEVICE_PID EQUAL 0x100)
message(WARNING message(WARNING
"CONFIG_USB_DEVICE_PID has default test value 0xBEEF. "CONFIG_USB_DEVICE_PID has default value 0x100.
This value is only for testing and MUST be configured for USB products." This value is only for testing and MUST be configured for USB products."
) )
endif()
endif() endif()

4
subsys/usb/Kconfig
View file

@ -39,14 +39,14 @@ config SYS_LOG_USB_LEVEL
config USB_DEVICE_VID config USB_DEVICE_VID
hex hex
prompt "USB Vendor ID" prompt "USB Vendor ID"
default 0xDEAD default 0x2FE3
help help
USB device vendor ID. MUST be configured by vendor. USB device vendor ID. MUST be configured by vendor.
config USB_DEVICE_PID config USB_DEVICE_PID
hex hex
prompt "USB Product ID" prompt "USB Product ID"
default 0xBEEF default 0x100
help help
USB device product ID. MUST be configured by vendor. USB device product ID. MUST be configured by vendor.