MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBusDxe / UsbEnumer.h

/** @file\r
\r
    USB bus enumeration interface.\r
\r
Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _USB_ENUMERATION_H_\r
#define _USB_ENUMERATION_H_\r
\r
//\r
// Advance the byte and bit to the next bit, adjust byte accordingly.\r
//\r
#define USB_NEXT_BIT(Byte, Bit)   \\r
          do {                \\r
            (Bit)++;          \\r
            if ((Bit) > 7) {  \\r
              (Byte)++;       \\r
              (Bit) = 0;      \\r
            }                 \\r
          } while (0)\r
\r
\r
//\r
// Common interface used by usb bus enumeration process.\r
// This interface is defined to mask the difference between\r
// the root hub and normal hub. So, bus enumeration code\r
// can be shared by both root hub and normal hub\r
//\r
typedef\r
EFI_STATUS\r
(*USB_HUB_INIT) (\r
  IN USB_INTERFACE        *UsbIf\r
  );\r
\r
//\r
// Get the port status. This function is required to\r
// ACK the port change bits although it will return\r
// the port changes in PortState. Bus enumeration code\r
// doesn't need to ACK the port change bits.\r
//\r
typedef\r
EFI_STATUS\r
(*USB_HUB_GET_PORT_STATUS) (\r
  IN  USB_INTERFACE       *UsbIf,\r
  IN  UINT8               Port,\r
  OUT EFI_USB_PORT_STATUS *PortState\r
  );\r
\r
typedef\r
VOID\r
(*USB_HUB_CLEAR_PORT_CHANGE) (\r
  IN USB_INTERFACE        *HubIf,\r
  IN UINT8                Port\r
  );\r
\r
typedef\r
EFI_STATUS\r
(*USB_HUB_SET_PORT_FEATURE) (\r
  IN USB_INTERFACE        *UsbIf,\r
  IN UINT8                Port,\r
  IN EFI_USB_PORT_FEATURE Feature\r
  );\r
\r
typedef\r
EFI_STATUS\r
(*USB_HUB_CLEAR_PORT_FEATURE) (\r
  IN USB_INTERFACE        *UsbIf,\r
  IN UINT8                Port,\r
  IN EFI_USB_PORT_FEATURE Feature\r
  );\r
\r
typedef\r
EFI_STATUS\r
(*USB_HUB_RESET_PORT) (\r
  IN USB_INTERFACE        *UsbIf,\r
  IN UINT8                Port\r
  );\r
\r
typedef\r
EFI_STATUS\r
(*USB_HUB_RELEASE) (\r
  IN USB_INTERFACE        *UsbIf\r
  );\r
\r
/**\r
  Return the endpoint descriptor in this interface.\r
\r
  @param  UsbIf                 The interface to search in.\r
  @param  EpAddr                The address of the endpoint to return.\r
\r
  @return The endpoint descriptor or NULL.\r
\r
**/\r
USB_ENDPOINT_DESC*\r
UsbGetEndpointDesc (\r
  IN USB_INTERFACE        *UsbIf,\r
  IN UINT8                EpAddr\r
  );\r
\r
/**\r
  Select an alternate setting for the interface.\r
  Each interface can have several mutually exclusive\r
  settings. Only one setting is active. It will\r
  also reset its endpoints' toggle to zero.\r
\r
  @param  IfDesc                The interface descriptor to set.\r
  @param  Alternate             The alternate setting number to locate.\r
\r
  @retval EFI_NOT_FOUND         There is no setting with this alternate index.\r
  @retval EFI_SUCCESS           The interface is set to Alternate setting.\r
\r
**/\r
EFI_STATUS\r
UsbSelectSetting (\r
  IN USB_INTERFACE_DESC   *IfDesc,\r
  IN UINT8                Alternate\r
  );\r
\r
/**\r
  Select a new configuration for the device. Each\r
  device may support several configurations.\r
\r
  @param  Device                The device to select configuration.\r
  @param  ConfigIndex           The index of the configuration ( != 0).\r
\r
  @retval EFI_NOT_FOUND         There is no configuration with the index.\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource.\r
  @retval EFI_SUCCESS           The configuration is selected.\r
\r
**/\r
EFI_STATUS\r
UsbSelectConfig (\r
  IN USB_DEVICE           *Device,\r
  IN UINT8                ConfigIndex\r
  );\r
\r
/**\r
  Remove the current device configuration.\r
\r
  @param  Device                The USB device to remove configuration from.\r
\r
  @return None.\r
\r
**/\r
EFI_STATUS\r
UsbRemoveConfig (\r
  IN USB_DEVICE           *Device\r
  );\r
\r
/**\r
  Remove the device and all its children from the bus.\r
\r
  @param  Device                The device to remove.\r
\r
  @retval EFI_SUCCESS           The device is removed.\r
\r
**/\r
EFI_STATUS\r
UsbRemoveDevice (\r
  IN USB_DEVICE           *Device\r
  );\r
\r
/**\r
  Enumerate all the changed hub ports.\r
\r
  @param  Event                 The event that is triggered.\r
  @param  Context               The context to the event.\r
\r
  @return None.\r
\r
**/\r
VOID\r
EFIAPI\r
UsbHubEnumeration (\r
  IN EFI_EVENT            Event,\r
  IN VOID                 *Context\r
  );\r
\r
/**\r
  Enumerate all the changed hub ports.\r
\r
  @param  Event                 The event that is triggered.\r
  @param  Context               The context to the event.\r
\r
  @return None.\r
\r
**/\r
VOID\r
EFIAPI\r
UsbRootHubEnumeration (\r
  IN EFI_EVENT            Event,\r
  IN VOID                 *Context\r
  );\r
#endif\r