UCM$HELP.HLB  —  ADD

1  –  DEVICE 

    Allows you to add a new device to the collection of known USB
    devices.

    Requires SYSPRV privilege.

    Format

      ADD DEVICE  device-name:

1.1  –  Parameter 

 device-name:

    The name of the device whose characteristics are to be added. The
    device name has the form ddcu

    where:

    dd    is the device code-for example, LP. (The driver name
          corresponds to the device code; in this case, the driver
          name would be SYS$LPDRIVER.)

    c     is the controller designation A through Z; unless UCM
          specifies a different letter, all USB devices are A.

    u     is the unit number (0 through 9999).

    OpenVMS device names are made up of the two-character device
    code, followed by the controller designation, the unit number
    (which can be 1 to 4 characters long), and, finally, a colon (:).

1.2  –  Qualifiers

1.2.1    /BUS_NUMBER 

       /BUS_NUMBER=number

    Specifies the USB bus number of the device. This parameter is
    required to identify a particular device on a system that has
    multiple USB buses. If you do not use this qualifier, the bus
    number defaults to zero.

    The number can be from 0 through 25.

1.2.2    /PATH 

       /PATH=(n1[.n2.n3.n4.n5.n6])

    Specifies the path to the device on the bus. The path is used
    to identify a device uniquely if the device does not have a
    serial number. The path specification is a series of six or fewer
    nonzero numbers,

    where:

    n1               is the number of the port on the root hub (at
                     tier 0).

    n2 through n6    are port numbers for downstream hubs at tiers 1,
                     2, 3, 4, and 5. (If you do not specify trailing
                     zeros, the UCM server supplies them.)

    For example, /PATH=1.4.3 indicates that the device is plugged
    into port 3 of the second tier hub, which is plugged into port 4
    of the first tier hub, which in turn is plugged into the root hub
    1.

    For a more detailed explanation of path specifications, see
    <REFERENCE>(tiers) and the text that introduces the figure.

1.2.3    /UNIT_NUMBER 

       /UNIT_NUMBER=number

    Unit numbers can be between 0 and 9999. By default, UCM selects
    the next available unit number. This qualifier allows you to
    change the unit number to suit your needs.

1.3  –  Example 

  $  UCM
  Universal Serial Bus Configuration Manager, Version V1.0
  UCM> SHOW DEVICE /UNCONFIGURED
  DEVICE
  DEVICE_TYPE                     TENTATIVE
  DEVICE_NAME_ROOT                AGA
  UNIT_NUMBER                     0
  BUS                             1
  PATH                            1.0.0.0.0.0
  END_DEVICE

  UCM> ADD DEVICE AGA0:
  UCM> SHOW DEVICE /PERMANENT /FULL AGA0:
  DEVICE
  DEVICE_TYPE                     PERMANENT
  DEVICE_NAME_ROOT                AGA
  UNIT_NUMBER                     0
  DRIVER                          SYS$AGDRIVER.EXE
  BUS_NUMBER                      1
  PATH                            1.0.0.0.0.0
  HID_USAGE_DATA                  65540
  BEGIN_INTERFACE
  HID_USAGE_DATA                  65540
  END_INTERFACE
  END_DEVICE
  UCM>

      In this example, the first UCM command SHOW DEVICE
      /UNCONFIGURED indicates that the device has not yet been
      configured. It displays only the information that appears in
      the generic list: the device name root, the unit number, the
      bus, and the path.

      After the ADD DEVICE command, the second SHOW DEVICE command,
      with the /PERMANENT and /FULL qualifiers, displays the
      information in the permanent list. The list includes the name
      of the driver assigned to the device, the bus number; and the
      Human Interface Device (HID) usage data number, which is used
      to configures devices in the HID interface class. Examples of
      HID devices are keyboards, mice, joysticks, and so on.
Close Help