Universal Serial Bus ({{bibref|USB1.0}}, {{bibref|USB2.0}}, {{bibref|USB3.0}}). This object contains the {{object|Interface}}, {{object|Port}}, and {{object|USBHosts}} objects. {{numentries}} USB interface table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class. The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the {{param|##.Ethernet.Link.{i}.MACAddress}} parameter. {{reference}} This is the USB port associated with this interface object. USB Port table. This table models master and slave USB physical ports on the device. The textual name of the port. USB specification version supported by the Port. Example: "1.1" Type of the USB connection. Receptacle of the port. Current speed of the USB connection. {{enum}} 1.5 Mbits/sec (187.5 KB/sec) defined in {{bibref|USB1.0}} 12 Mbits/sec (1.5 MB/sec) defined in {{bibref|USB1.0}} 480 Mbits/sec (60 MB/sec) defined in {{bibref|USB2.0}} 5.0 Gbits/sec (625 MB/sec) defined in {{bibref|USB3.0}} Power configuration of the USB connection. {{enum}} Only applies when {{param|Type}} is {{enum|Device|Type}}. In other cases value is {{enum|Unknown}}. This object models the CPE's USB Host controllers. See {{bibref|TR-181i2|Appendix XVII}} for Theory of Operation. {{numentries}} {{numentries}} When set to {{true}}, all USB devices are allowed to connect to the Device and the configuration mentioned in {{object|.USB.USBHosts.AllowedDevice.}} is ignored. When set to {{false}}, only USB devices listed in {{object|.USB.USBHosts.AllowedDevice.}} are allowed to connect to the Device. Any USB device not explicitly listed will be rendered inactive. Table of CPE USB Host controllers. Enables or disables the USB Host controller. User-readable host controller name. Type of USB Host Unknown Host Controller Interface Open Host Controller Interface Enhanced Host Controller Interface Universal Host Controller Interface Extensible Host Controller Interface When set to {{true}}, {{param}} enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see {{bibref|USB2.0}}, Chapters 4.3.2, 7.1.7.6, and 11.9). When set to {{false}} {{param}} immediately disables the Host controller Power Management policy. USB specification version with which the controller complies. Example: "1.1" {{numentries}} Table of connected USB devices. Device number on USB bus. USB specification version with which the device complies. Example: "1.1" Class Code as assigned by USB-IF. When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified. Subclass code (assigned by USB-IF). Device release number. Protocol code (assigned by USB-IF). Product ID (assigned by manufacturer). Vendor ID (assigned by USB-IF). Device Manufacturer string descriptor. Device Product Class string descriptor. Device SerialNumber string descriptor. Hub port on parent device. 0 when no parent. {{reference}} This is a reference to the USB host device to which this (external) USB device is connected. Speed of the USB device. {{enum}} Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate. No valid rate negotiated 1.5 Mbits/sec (187.5 KB/sec) defined in {{bibref|USB1.0}} 12 Mbits/sec (1.5 MB/sec) defined in {{bibref|USB1.0}} 480 Mbits/sec (60 MB/sec) defined in {{bibref|USB2.0}} 5.0 Gbits/sec (625 MB/sec) defined in {{bibref|USB3.0}} {{reference}} This is a reference to the parent USB device (e.g. hub device). This is {{empty}} for a device connected to the Host controller (root hub). Number of ports. Only applies for hub device, equal to 0 for other devices. When {{true}} the associated Device is in a suspended (i.e. low-power) state (see {{bibref|USB2.0|Chapter 11.9}}). When {{false}} the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see {{bibref|USB2.0|Chapter 9.1.1}}). When {{true}} the associated device is at least partly powered by a local source (see {{bibref|USB2.0|Chapter 9.4.5}}). When {{false}} the associated device draws all the current it needs from the USB bus. Indicates the low-level device state, directly mapping to the "Visible Device States" in {{bibref|USB2.0|Table 9-1 Visible Device States}}. The device is physically connected to the USB port. This is the initial state upon connection, before the host has necessarily detected or powered it. See {{bibref|USB2.0|9.1.1.1 Attached}}. The device is receiving power from the host but has not yet been reset. The host is aware of the connection. See {{bibref|USB2.0|9.1.1.2 Powered}}. The device has been reset by the host and is now communicating on the default address. It is waiting for the host to assign it a unique address. See {{bibref|USB2.0|9.1.1.3 Default}}. A unique device address has been assigned by the host. The device is now in the Address state, ready for the host to learn about its capabilities by reading its descriptors. See {{bibref|USB2.0|9.1.1.4 Address}}. The device has been successfully configured by the host. It is now fully operational and its interfaces are active. See {{bibref|USB2.0|9.1.1.5 Configured}}. The device is in a low-power state to conserve energy. It maintains its address and configuration but is not actively communicating until it receives a resume signal from the host. See {{bibref|USB2.0|9.1.1.6 Suspended}}. When {{true}}, the associated USB device is allowed to connect to the Device USB Host controller(s) based on the configuration in {{object|.USB.USBHosts.AllowedDevice.}} and {{param|##.AllowAllDevices}}. When {{false}}, the associated USB device is not allowed to connect. {{numentries}} Table of device configurations. The identifier for each Device Configuration. {{numentries}} Table of device interface descriptors. Number of this interface (from USB interface descriptor). Class Code as assigned by USB-IF. When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified. Subclass code (assigned by USB-IF). Protocol code (assigned by USB-IF). Table of USB devices permitted to connect to the Device USB Host controller(s). Each entry in this table defines an allowed device based on its e.g. USB Vendor ID and Product ID. Only USB devices listed here will be accepted by the Device; any USB device not explicitly listed will be rendered inactive. When a USB device is rendered inactive, the parameter value of {{param|#.Host.{i}.Device.{i}.IsAllowed}} is set to {{false}}, which prevents the {{param|#.Host.{i}.Device.{i}.DeviceState}} from reaching the {{enum|Configured|#.Host.{i}.Device.{i}.DeviceState}} status. Enables or disables whether the corresponding allowed USB device entry is active. If set to {{true}}, the device defined by this entry is permitted to connect to the system. If {{false}}, the device is ignored even if its identifiers match. A user-friendly description of the allowed USB device entry. Classification criterion. Class Code assigned by USB-IF, which can be expressed as a two-digit hexadecimal string (e.g., `00`), but can also include a wildcard character. When `00`, the device specifies its own class code. When `FF`, the class code is vendor-specific. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `F*` or `*3`). When empty, the device is not classified by Device Class. Classification criterion. Subclass code assigned by USB-IF, expressed as a two-digit hexadecimal string (e.g., `01`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `0*` or `*3`). When empty, the device is not classified by Device Subclass. Classification criterion. Protocol code assigned by USB-IF, expressed as a two-digit hexadecimal string (e.g., `02`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `0*` or `*2`). When empty, the device is not classified by Device Protocol. Classification criterion. Product ID assigned by the manufacturer, expressed as a two- to four-digit hexadecimal string (e.g., `5678`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `5*`). When empty, the device is not classified by Product ID. Classification criterion. Vendor ID assigned by USB-IF, expressed as a two- to four-digit hexadecimal string (e.g., `1234`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `1*`). When empty, the device is not classified by Vendor ID. Each item defines an allowed USB interface in the format 'InterfaceClass:InterfaceSubClass:InterfaceProtocol', using two-digit hexadecimal values (e.g., `FF`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `F*`). A connected device is allowed only if all of its interfaces match entries in this list. * InterfaceClass: USB Class Code (`00` = per-interface class, `FF` = vendor-specific) * InterfaceSubClass: USB Subclass Code * InterfaceProtocol: USB Protocol Code Example: An USB Device might expose two interfaces: * `0xFF:0x02:0x01` for diagnostics * `0xFF:0x02:0x02` for data These can be allowed by listing both explicitly, or using patterns like `FF:02:*` or `F*:0*:0*`. When empty, the device is not classified by Interfaces.