summaryrefslogtreecommitdiff
path: root/EdkModulePkg/Bus/Usb/UsbBus/Dxe/usbutil.h
blob: 259276cbafbbb6a8db4a776e8e5a0ae01202bf53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*++
 
Copyright (c) 2006, Intel Corporation                                                         
All rights reserved. This program and the accompanying materials                          
are licensed and made available under the terms and conditions of the BSD License         
which accompanies this distribution.  The full text of the license may be found at        
http://opensource.org/licenses/bsd-license.php                                            
                                                                                          
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

  Module Name:
    usbutil.h
  
  Abstract:
 
    Helper functions for USB
 
  Revision History
 
  
--*/

#ifndef _USB_UTIL_H
#define _USB_UTIL_H

//
// Following APIs are used to query Port Status
//
BOOLEAN
IsPortConnect (
  IN UINT16  PortStatus
  );

BOOLEAN
IsPortEnable (
  IN UINT16  PortStatus
  );

BOOLEAN
IsPortInReset (
  IN UINT16  PortStatus
  );

BOOLEAN
IsPortPowerApplied (
  IN UINT16  PortStatus
  );

BOOLEAN
IsPortLowSpeedDeviceAttached (
  IN UINT16  PortStatus
  );

BOOLEAN
IsPortSuspend (
  IN UINT16  PortStatus
  );

//
// Following APIs are used to query Port Change Status
//
BOOLEAN
IsPortConnectChange (
  IN UINT16  PortChangeStatus
  );

BOOLEAN
IsPortEnableDisableChange (
  IN UINT16  PortChangeStatus
  );

BOOLEAN
IsPortResetChange (
  IN UINT16  PortChangeStatus
  );

BOOLEAN
IsPortSuspendChange (
  IN UINT16  PortChangeStatus
  );

//
// Set device address;
//
EFI_STATUS
UsbSetDeviceAddress (
  IN  EFI_USB_IO_PROTOCOL     *UsbIo,
  IN  UINT16                  AddressValue,
  OUT UINT32                  *Status
  );


#endif