US 6389560 B1
A system and method for testing the conformance of a universal serial bus (USB) system to a set of predefined USB Specifications. One embodiment of the system comprises a USB interpreter that can be used to selectively examine device data, execute USB commands and exercise USB functions without having to create or compile a test program. The USB interpreter comprises a test application and a test application driver. The test application driver interfaces with the USB system software. The USB system software may include a USB driver, a host controller driver and other host software. The USB driver interfaces with the test application through the test application driver. The host controller driver interfaces with the host controller and thereby interfaces the software on the host system with the USB interconnect and USB devices. In one embodiment, the USB interpreter incorporates a command line interpreter through which a user can enter commands to perform specific operations and tests on the USB system. The user may execute commands in an operating system (e.g., Unix) shell without having to interrupt a USB testing or debugging session. The user may also enter commands and perform USB system testing remotely via a communications link between the user and the system's host computer.
1. A test system for determining compliance of a universal serial bus (USB) system to a set of predetermined specifications comprising:
a computer system wherein said computer system is configured to execute a test application and USB system software and wherein said computer system includes a host controller;
a USB interconnect coupled to said computer system and configured to be controlled by said host controller;
wherein said computer system is configured to accept test commands from a user, execution of each of said test commands being associated with a corresponding USB system operation, said operation being performed upon execution of said test command.
2. The test system of
3. The test system of
4. The test system of
5. The test system of
6. The test system of
7. The test system of
8. The test system of
9. The test system of
10. The test system of
11. The test system of
12. The test system of
13. The test system of
14. The test system of
15. The test system of
16. The test system of
17. A method for testing a function of a universal serial bus (USB) system of a computer, said USB system having a USB interconnect, one or more USB interfaces and one or more USB devices, the method comprising:
entering a test command on said computer;
interpreting said test command using a command line interpreter;
executing an operation associated with said test command;
transmitting a test signal to said USB system; and
validating a test result generated by said USB system in response to said test signal.
18. The method of
19. The method of
20. The method of
21. The method of
22. The method of
23. A method for testing a universal serial bus (USB) system, the USB system including a host computer system, a USB interconnect coupled to the host computer system and one or more USB devices coupled to the USB interconnect, the method comprising:
creating a node corresponding to one of said one or more USB devices;
opening said node;
obtaining state information for said one of said one or more USB devices;
storing said state information;
executing one or more tests based on said state information, each of said one or more tests corresponding to a particular function of said USB system; and
validating the results of said one or more tests.
24. The method of
25. The method of
26. The method of
27. The method of
28. The method of
29. The method of
1. Field of the Invention
The invention relates generally to computer systems and more particularly to methods and devices for testing the functional compatibility of peripheral devices with a universal serial bus.
2. Description of the Relevant Art
Since the advent of personal computers, computer users have been eager to expand the capabilities of their machines. Users, however, have experienced innumerable difficulties when confronted with the task of connecting peripheral devices to their computers. While it may be simple for a user to attach a printer to his or her computer, the connection of a device (e.g., a scanner) to a serial port presents more of a challenge. The installation of equipment internal to the computer, such as an interface card for a scanner, may present even greater difficulties, as the user may face problems in setting I/O and DMA addresses for resolving IRQ conflicts. These difficulties can frustrate the user, particularly when they cause the computer to operate incorrectly or simply fail to operate at all.
With the rapid advances in the state of computer technology, the potential for experiencing such difficulties has grown. There have, as a result, been attempts to alleviate these problems. For example, the concept of designing plug-and-play peripheral devices was intended to alleviate difficulties of installing the devices. This concept, however, is directed primarily toward devices which are installed inside the cabinet of the computer. The installation of external peripheral devices, such as printers and scanners, is still likely to be accompanied by some of the difficulties targeted by the plug-and-play concept.
Another attempt to eliminate some of the problems attendant to the installation of peripheral devices was the introduction of PC-Card technology. (This technology was formerly termed PCMCIA—Personal Computer Memory Card International Association.) PC-Card (PCMCIA) peripheral devices are simply and easily inserted into a PC-Card socket and are recognized by the computer. The problem with this technology, however, was that it was originally targeted to portable computers. Although a PC-Card (PCMCIA) slot can be installed in a desktop computer, this solution simply has not been widely adopted. Thus, there remained a need for a simple and convenient plug-and-play type technology for desktop computers.
One or more of the problems outlined above may be solved by various embodiments of the system and method of the present invention. In response to the continuing difficulties in installing peripheral devices and the need for a solution to the problem, the idea of a universal serial bus (USB) was developed. The development of the USB was motivated by number of factors, including the difficulty of adding peripheral devices and the lack of additional ports for installing these devices. The USB is designed to provide plug-and-play capabilities for external peripheral devices which are connected to the I/O ports of the computer and thereby reduce the difficulties experienced by many users. The USB was also designed to provide means for installing numerous devices rather than restricting the user to one or two (one for each port on a computer which does not have a USB).
The implementation of plug-and-play capabilities through the USB is not solely dependent upon the USB. It is fundamental that the peripheral devices to be installed on the USB must be compatible with the USB. In other words, it is necessary that the devices conform to the specific characteristics of the USB. This is ensured in part by the propagation of the USB Specification, which defines these characteristics. The USB Specification is hereby incorporated herein by reference in its entirety. The designs of peripheral devices can be checked prior to manufacture through device simulations. Such verification of device designs, however, may themselves contain errors. Additionally, errors may be introduced in translation of the design into a physical device. It is therefore important to have means for verifying different aspects of USB compatibility of peripheral devices in their final physical configurations. It is also important to have means for verifying USB system functions apart from the peripheral devices. The various embodiments of the invention provide such means.
One embodiment of the invention comprises a USB interpreter. The USB interpreter is a software tool that can be used in a USB system to selectively examine device data, execute USB commands and exercise USB functions. The USB interpreter can perform these functions without having to create or compile a test program and can therefore be very useful in debugging devices with respect to USB compliance. The USB interpreter can also be used in the development of USB software.
The USB interpreter comprises a test application and a test application driver. The test application driver interfaces with the USB system software. The USB system software, which may include a USB driver, a host controller driver and other host software, is sometimes referred to as the USB framework support. The USB driver interfaces with the test application through the test application driver. The host controller driver interfaces with the host controller, which in turn interfaces the software on the host system with the USB interconnect and USB devices.
In one embodiment, the USB interpreter incorporates a command line interpreter through which a user can enter commands to perform specific operations and tests on the USB system. The user may thereby avoid performing unnecessary tests on previously verified portions of the system. The use of the command line interpreter further allows the user to execute commands in an operating system (e.g., Unix) shell without having to interrupt a USB testing or debugging session. The use of the command line interpreter also allows the user to enter commands remotely (e.g., via a modem connected to the computer system) so that the expertise of a user who is not located at the site of the computer system.
Other objects and advantages of the invention will become apparent upon reading the following detailed description and upon reference to the accompanying drawings in which:
FIG. 1 is a block diagram illustrating the physical configuration of a plurality of USB peripheral devices attached to a computer system.
FIG. 2 is a block diagram illustrating the primary physical components of a USB system.
FIG. 3 is a block diagram illustrating the tiered star physical configuration of a plurality of devices connected to hubs on a USB interconnect.
FIG. 4 is a block diagram illustrating the simple star logical configuration of a plurality of devices connected to a USB interconnect.
FIG. 5 is a functional block diagram illustrating the logical and physical flows of data within a USB system.
FIG. 6 is a functional block diagram illustrating the logical and physical flows of data within the host in a USB system.
FIG. 7 is a diagram illustrating the flow of data between client software in the USB host and a plurality of endpoints in a USB device.
FIG. 8 is a diagram illustrating the structure of the USB test application in one embodiment of the invention.
While the invention is susceptible to various modifications and alternative forms, specific embodiments thereof are shown by way of example in the drawings and will herein be described in detail. It should be understood, however, that the drawing and detailed description thereto are not intended to limit the invention to the particular form disclosed, but on the contrary, the intention is to cover all modifications, equivalents and alternatives falling within the spirit and scope of the present invention as defined by the appended claims.
One embodiment of the invention is described below. In this embodiment, a host computer utilizes a USB system. The USB system includes a USB, a USB host controller coupled to the USB, a host controller driver for driving the host controller and a set of USB interfaces which allow communications between a test application and the host controller driver. The test application comprises a USB interpreter which is used to selectively test the functions of the USB system. Specifically, the application is configured to examine standard device descriptors, query USB devices using standard device requests and exercise individual USB interface functions. The USB interpreter allows the user to take these actions without having to first create and compile a test application. The USB interpreter thereby allows a user to selectively obtain information which facilitates debugging of USB devices and related software.
The development of the USB was motivated primarily by three considerations. First, personal computers have traditionally had limited flexibility in regard to reconfiguration of the computer. A number of advances were made in the areas of graphical user interfaces and internal bus architectures which made personal computers more user-friendly, but there was little progress in improving the connectivity of peripheral devices to desktop systems (despite the success of PC-Card plug-and-play peripherals in portable computers.) Second, personal computers typically had a limited number of ports to which peripheral devices could be connected. A typical system, for example, might have a single parallel port and one or two serial ports. Users were therefore prevented from having more than two or three peripheral devices corresponding to the two or three ports on their computers. Third, although there has been significant potential for computing and communication functions to benefit from each other, these technologies have evolved essentially independently so that the technologies were not easily merged. There was therefore a need for an easy and inexpensive means to communicate information via computers. The USB was designed to meet these needs.
Referring to FIG. 1, the USB is a bus designed to provide a simple and efficient method for connecting external peripheral devices to desktop computer systems. The figure shows a computer system 10 connected to several peripheral devices 11-15. The devices are connected to the USB port 16 on the computer system via hubs 17-18. The use of hubs 17-18 on the USB enables users to expand the number of devices which can be connected to the computer system (as compared to the two or three which could be directly connected to a non-USB system.) The system may also include compound devices 12 which serve as both hubs and functional devices. (Note that device 13 is connected to the USB via compound device 12.)
Referring to FIG. 2, a block diagram illustrating the primary physical components of a USB system is shown. The physical USB system can be described in three parts: a USB host 20; USB devices 22; and a USB interconnect 21. The first of these parts, the USB host, is the computer system which incorporates the USB root hub and forms the basis of the USB system. The second part, the USB devices, comprise the peripherals and functional devices which are to be connected to the computer system. USB “devices” may also refer to the hubs which can be connected to the USB to provide additional attachment ports. The third part, the USB interconnect, comprises the physical connections between the USB devices and the USB host, as well as the manner in which the devices communicate with host.
There is a single host associated with any USB system. The host is the computer system in which the USB system is implemented. The host incorporates a root hub of the USB which provides one or more attachment points for devices or other hubs. A host controller provides the interface between the host and the USB. The host controller may be implemented in one or a combination of hardware, firmware and software.
The USB devices are functional devices which provide capabilities to the system (e.g., an ISDN modem, a joystick or a set of speakers.) The USB devices may also be hubs which provide additional attachment points to the USB to which additional devices may be connected. (Non-hub devices are sometimes referred to as functions.) Some USB devices serve as both functional devices and hubs to which other devices can be attached. The USB Specification requires that all USB devices conform to certain interface standards and thereby ensures that the devices comprehend the USB protocol and respond to standard USB requests and commands.
The physical aspects of the USB interconnect are defined by the bus topology. (Although the bus topology includes non-physical aspects of the USB interconnect, they will be addressed elsewhere in this disclosure.) The bus topology describes the manner in which the USB connects USB devices with the USB host. Referring to FIG. 3, the physical configuration of the USB interconnect is that of a tiered star. The host has a root hub which forms the basis of the interconnect. Devices and/or additional hubs can be connected to the root and other hubs to form successive tiers of the interconnect. Thus, each hub forms the center of one of the stars in the tiered star configuration. Each wire segment in the interconnect is a point-to-point connection between the host or a hub and another hub or a device.
USB systems support “hot plugging”. That is, USB devices may be attached to or removed from the USB at any time. The USB is designed to detect these changes in its physical topology and accommodate the changes in the available functions. All USB devices are connected to the USB at one of the hubs (either the root hub or one of the hubs chained from the root.) Attachment or removal of a device at a hub is indicated in the hub's port status. If a device is attached to the hub, the hub sends a notification to the host. The host then sends a query to the hub to determine the reason the notification was sent to the host. In response to this query, the hub sends the number of the port to which the device was attached to the host. The host then enables this port and begins communicating with the device via the control pipe (0 endpoint.) The host determines whether the attached device is a hub or a function and assigns a unique USB address to the device. The unique USB address and the 0 endpoint of the device are used as a control pipe for the device. If the newly attached device is a hub which already has devices attached to its ports, this same process is repeated for each of the attached devices. After a device has been attached and communications established between the device and the host, notifications are sent to interested host software.
If a device is removed from a hub, the hub disables the port to which the device had been attached and sends notification of the device's removal to the host. The host then removes the device and related data from any affected data structures. If the removed device is a hub to which other devices are attached, the removal process is repeated for each of the devices attached to the removed hub. Notifications are sent to interested host software indicating that the removed devices are no longer available.
Although the physical topology of the USB interconnect is that of a tiered star configuration, the logical topology of the system is a simple star as shown in FIG. 4. Alternately, the logical configuration can be considered a series of direct connections between the individual USB devices and a client software application on the host. The logical relationship of the client software to the devices can also be thought of as one or more direct connections between the client software and the specific functions provided by the devices. While the view of the logical configuration as being a series of direct connections holds true for most operations, the system remains aware of the tiered physical topology so that devices downstream from a removed hub can be removed from the logical configuration when the hub is removed (see the discussion of hot-swapping above.)
The USB provides means for communications between client software running on the host and functions provided by the USB devices. FIGS. 5 and 6 illustrate the flow of data which is communicated between the client software and the device functions. The figures show the host as comprising three components: the client software; the USB system software (including USB driver, host controller driver and host of software); and the USB host controller. The host controller driver interfaces the host controller with the USB system software, and the USB driver interfaces the USB system software with the client software. FIG. 5 shows that the USB device also comprises three components: the function; the logical device; and the USB bus interface.
While the logical flow of information between the client software and the function is direct, the figure shows that the actual flow of data goes from the client software to the USB system software, to the USB host controller, to the USB bus interface, to the USB logical device and finally to the function. Likewise, although the logical flow of control information from the USB system software to the USB logical device is direct, the actual flow of information must go through the host controller and the bus interface.
Referring to FIG. 7, a USB logical device is viewed by the USB system as an interface formed by a collection of endpoints. An endpoint is a uniquely identifiable portion of a USB device that forms the end of a communications path from the host to the device. Software may only communicate with a USB device via its endpoints. (The communications flow is illustrated in the figure by the arrows.) The number of each endpoint is determined by the designer of the device. The combination of a device address (assigned by the system at device attachment time) and the endpoint number allows each endpoint to be uniquely identified.
All USB devices are required to have an endpoint with number 0. This endpoint is used to initialize and manipulate (e.g., to configure) the logical device. Endpoint 0 provides access to the device's configuration information and allows access to the device for status and control purposes. Devices can have additional endpoints as required to implement their functions. Devices can have up to 16 additional input endpoints and 16 additional output endpoints (unless they are not full-speed devices, in which case they are limited to a reduced number of endpoints.).
The communications path between an endpoint on a device and software on the host is referred to as a pipe. A pipe comes into existence when a USB device is configured. Software clients normally request data transfers via I/O Request Packets (IRPs) to a pipe. The software clients then either wait or are notified when the requests are completed. Endpoint 0 has an associated pipe called the Default Pipe. The Default Pipe is used by system software to determine device identification and configuration requirements and to configure the device. The Default Pipe can also be used by device specific software after the device is configured, but the USB system software retains “ownership” of the Default Pipe and controls its use by client software.
Referring to FIG. 8, the software structure of one embodiment of the invention is shown. The client software in this embodiment comprises a test application 30 and a test application driver 31. The USB system software 32 comprises USB driver 33 and host control driver 34. The USB driver 33 and host control driver 34 are part of the USB Framework Support. The USB Framework Support is a Solaris based implementation of the USB system software and includes a set of interfaces (USB Architecture Interfaces, or USBAI) which allow third party vendors to write USB client drivers on a Solaris SPARC platform.
Test application 30 includes modules configured to control testing of the different functions of the USB system. In this instance, the separation of the modules' capabilities generally conforms to the separation of USB functionalities defined in the USB Specification. For example, one module 35 controls the testing of standard device requests defined in Chapter 9 of the Specification, while another module 36 controls testing of hub standard requests as defined in Chapter 11 and another module 38 controls the testing of USBAI functions. Interpreter module 37 does not provide for the testing of a separate set of functions, but instead supports testing of all of the USB functions. These modules are all operatively coupled to the body 39 of the test application.
Test application driver 31 is similarly structured, having a main driver component 40 and several modules 41-44 which correspond to the modules of application 30. Test application driver 31 is a loadable driver. That is, when a USB device is hot-plugged, the USB architecture framework will load the driver and create a device node for the newly installed device. If the device is hot-unplugged, the driver will be unloaded as to the unplugged device.
The test application may be run on any USB device after it is installed. In one embodiment, the application, which is controlled primarily by the interpreter module, takes a device node as an argument, opens the device node and constructs state information for the device based on descriptor information obtained from the device. Test application driver 31 maintains the device state for use in testing the device. System test resources are allocated based on the constructed state information. The state information is also used as the basis of test requests which may be formulated by application 30. The test requests are forwarded to USBI module 43 of the test application driver 31, which decodes and validates the test parameters. If the test parameters are valid (i.e., within the allowable limits of the parameters,) the test application 30 and application driver 31 construct test cases using USBAI functions. The corresponding function calls are transmitted to the USB driver, which executes the functions. Test application driver 31 updates the state information for the device when the function calls are issued and notifies test application 30 of the pass/fail status of the tests after the test functions are performed. Test application 30 then notifies the user.
In one embodiment, the test application runs a suite of tests to verify all of the USBAI function calls. The application opens a device node, constructs state information for the device and allocates system resources based on the state information. The USBAI module 38 of the test application 30 formulates test requests and parameters based on the state information and conveys the test requests and parameters to the USBAI module 42 of the test application driver 31 for validation. After validating the test requests and parameters, the USBAI module of the test application driver formulates a series of test cases using the USBAI functions. The USBAI module of the test application driver then makes USBAI function calls corresponding to the test cases to the USB system software. The USBAI module of the test application driver returns a pass or fail indication to the test application after analyzing the results of the function calls. This same process is repeated for all of the endpoints in the selected USB device. The test application may spawn multiple threads to allow concurrent testing of the different endpoints. Some embodiments may also provide for concurrent testing of multiple USB devices.
In a similar manner, the test application may run a suite of tests to verify that a USB device can provide appropriate device information in response to all of the standard device requests defined in the USB Specification. The application again opens a device node, constructs state information for the device and allocates system resources based on the state information. All of the standard device requests are packaged in a request structure which is passed to the test application driver. The Chapter 9 module 41 of the test application driver 31 validates the commands in the request structure and then conveys the requests to the USB device via the Default Pipe. The information provided by the device in response to the standard device requests is then returned to the test application.
Different embodiments of the invention may include various features. One such feature is a command line mode. In command line mode, a user may input individual commands which are interpreted and executed by the application to test particular functions of the USB system. This can eliminate unnecessary testing which would be performed by a comprehensive suite of tests. Commands may, however, also be set up to execute a series of operations instead of a single operation.
The command line mode also allows the test application to be used remotely. In other words, the user does not have to be physically present to test the USB system. The user may instead establish communications with the test system and enter commands through the communications link. For example, the user may establish a modem connection between a remote computer and the test system and then enter commands via the modem connection. The link may utilize any suitable means for communicating, and the foregoing example of a modem-based link is intended to be illustrative rather than limiting.
The user may also execute commands which are unrelated to the test system (e.g., Unix shell commands) without having to interrupt the test session. The time normally required to start and terminate other test systems to perform non-system functions may therefore be avoided. The command line mode can be configured to alias the available commands to a unique list to reduce the amount of typing which is required. The test system can also be configured to provide online help to facilitate the user's interaction with the system.
One embodiment of the test system is configured with a functional mode in which the system can single-step through a USBAI function. This may be useful when the user needs to examine traffic on the USB. After a USBAI function command is issued, USB traffic may be examined using a logic analyzer as each step of the function is performed. This can be a valuable debugging feature.
Another feature which may be included is the capability of switching ports during testing. As mentioned above, the system is configured to perform device enumeration. That is, when there are multiple USB devices connected to the system, it can list all the connected devices and construct state information such as port number, device type, device class and path for each of the devices. The user can select the device at a particular port for certain tests and then switch to a different port and test the device connected to that port.
In addition to determining device information for the purpose of testing the devices, the test system may be configured to make this information available to the user. Information such as device descriptors can be displayed in a matrix format to enable the user to make side-by-side comparisons of the characteristics of individual devices. Because bus enumeration is an ongoing activity in the USB system, devices are recognized as they are connected to the USB and the information which is normally obtained on the devices can be displayed alongside information for previously installed devices. Likewise, information corresponding to devices which are removed from the USB system can be removed from the display.
In one embodiment, the commands which can be input to the test system can be grouped into four categories: commands relating to device state information; standard device request commands; USB architecture interface commands; and miscellaneous commands. Although a number of these commands are listed below, this list is not intended to be limiting. It is contemplated that the USB Specification may be amended to add, delete or modify the allowed commands to accommodate the changing functionality of the USB, and the test system may be adapted to include the new commands and functions of the USB.
The device state information commands are shown in Table 1 along with their corresponding functions. Device state information is tracked for the devices enumerated and identified by the test system. When an endpoint of a device is accessed, its state is updated in the test system.
The standard device requests are defined in Chapter 9 of the USB Specification. The standard device requests are shown in Table 2 along with their corresponding functions. All USB devices are required to respond to standard device requests from the host. These requests are made via the device's default pipe using control transfers. The request and the request's parameters are sent to the device in the setup packet.
The USBAI commands are shown in Table 3 along with their corresponding functions. The USBAI commands are issued to a particular endpoint of a selected device. The USBAI functions corresponding to these commands can be executed in single-step mode in order to allow the user to examine traffic on the USB.
In addition to the foregoing commands, the test application provides for the following miscellaneous commands (see Table 4.)
While the present invention has been described with reference to particular embodiments, it will be understood that the embodiments are illustrated and that the invention scope is not so limited. Any variations, modifications, additions and improvements to the embodiments described are possible. These variations, modifications, additions and improvements may fall within the scope of the invention as detailed within the following claims.