Jump to main content

##

# 3.2.4.38 USB_HOST_TPL_FLAGS Enumeration

## C

    typedef enum
    {

        TPL_FLAG_VID_PID =  						 (1<<0),
        TPL_FLAG_CLASS_SUBCLASS_PROTOCOL = 			     (0<<0),
        TPL_FLAG_IGNORE_CLASS = 					   (1<<1),
        TPL_FLAG_IGNORE_SUBCLASS = 					(1<<2),
        TPL_FLAG_IGNORE_PROTOCOL = 					(1<<3),
        TPL_FLAG_PID_MASKED =                                       (1<<4),
        TPL_FLAG_IGNORE_VID_PID = 					  (1<<5),

    } USB_HOST_TPL_FLAGS;

## Description

USB Host Layer TPL Table Entry Matching Criteria flag.

This enumeration defines the possible matching criteria flag that can be specified for a Host TPL table entry. The tplFlag member of the TPL table entry should be set to one or more of these flags. These flags define the criteria that the Host layer will use while matching the attached device to the TPL table entry. For example, if a device is specified by class, subclass and protocol specifying the TPL_FLAG_IGNORE_SUBCLASS flag will cause the Host layer to ignore the subclass while comparing the class, subclass and protocol of the attached device.

Multiple flags can be specified as a logically OR'ed combination. While combining multiple flags, VID and PID criteria flags cannot be combined with the Class, Subclass, Protocol flags. For example, the TPL_FLAG_VID_PID flag cannot be combined with TPL_FLAG_IGNORE_SUBCLASS.

## Members

Members | Description
TPL_FLAG_VID_PID | Match by VID and PID. This flag can be used when the device member of the TPL table entry is a VID and PID entry type.
TPL_FLAG_CLASS_SUBCLASS_PROTOCOL | Match by Class, Subclass and Protocol. This flag can be used when the device member of the TPL table entry is a Class, Subclass, Protocol entry type.
TPL_FLAG_IGNORE_CLASS | Ignore Class, only consider subclass and protocol. This flag can be used when the device member of the TPL table entry is a Class, Subclass, Protocol entry type.
TPL_FLAG_IGNORE_SUBCLASS | Ignore Subclass, consider only class and protocol. This flag can be used when the device member of the TPL entry is a Class, Subclass or Protocol entry type.
TPL_FLAG_IGNORE_PROTOCOL | Ignore protocol, consider only class and subclass. This flag can be used when the device member of the TPL entry is a Class, Subclass or Protocol entry type.
TPL_FLAG_PID_MASKED | Mask the specified bits in the device PID and then match it against the PID in the TPL table. The bits to be masked is specified in the pidMask member of the TPL table entry. The 0 bits in the PID mask indicate the bits to ignored while comparing the device PID to the PID specified in the TPL. See USB_HOST_TARGET_PERIPHERAL_LIST description for examples. This flag can be used when the device member of the TPL table entry is a VID and PID entry type.
TPL_FLAG_IGNORE_VID_PID | Ignore the VID and PID while matching a device based on VID and PID.

## Remarks

None.