summaryrefslogtreecommitdiff
path: root/EmbeddedPkg/Include/Protocol/EmbeddedGpio.h
blob: b8bc929b77d4a8c02317a5b61259841659454cf2 (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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/** @file

  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>

  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.

**/

#ifndef __EMBEDDED_GPIO_H__
#define __EMBEDDED_GPIO_H__

//
// Protocol interface structure
//
typedef struct _EMBEDDED_GPIO   EMBEDDED_GPIO;

//
// Data Types
//
typedef UINTN EMBEDDED_GPIO_PIN;

#define GPIO(Port, Pin) ((EMBEDDED_GPIO_PIN)(((Port) << (16)) | (Pin)))
#define GPIO_PIN(x)     ((EMBEDDED_GPIO_PIN)(x) & (0xFFFF))
#define GPIO_PORT(x)    ((EMBEDDED_GPIO_PIN)(x) >> (16))

typedef enum {
  GPIO_MODE_INPUT                 = 0x00,
  GPIO_MODE_OUTPUT_0              = 0x0E,
  GPIO_MODE_OUTPUT_1              = 0x0F,
  GPIO_MODE_SPECIAL_FUNCTION_2    = 0x02,
  GPIO_MODE_SPECIAL_FUNCTION_3    = 0x03,
  GPIO_MODE_SPECIAL_FUNCTION_4    = 0x04,
  GPIO_MODE_SPECIAL_FUNCTION_5    = 0x05,
  GPIO_MODE_SPECIAL_FUNCTION_6    = 0x06,
  GPIO_MODE_SPECIAL_FUNCTION_7    = 0x07
} EMBEDDED_GPIO_MODE;

typedef enum {
  GPIO_PULL_NONE,
  GPIO_PULL_UP,
  GPIO_PULL_DOWN
} EMBEDDED_GPIO_PULL;

//
// Function Prototypes
//
typedef
EFI_STATUS
(EFIAPI *EMBEDDED_GPIO_GET) (
  IN  EMBEDDED_GPIO       *This,
  IN  EMBEDDED_GPIO_PIN   Gpio,
  OUT UINTN               *Value
  );
/*++

Routine Description:

  Gets the state of a GPIO pin

Arguments:

  This  - pointer to protocol
  Gpio  - which pin to read
  Value - state of the pin

Returns:

  EFI_SUCCESS - GPIO state returned in Value

--*/


typedef
EFI_STATUS
(EFIAPI *EMBEDDED_GPIO_SET) (
    IN EMBEDDED_GPIO      *This,
    IN EMBEDDED_GPIO_PIN  Gpio,
    IN EMBEDDED_GPIO_MODE Mode
    );
/*++

Routine Description:

  Sets the state of a GPIO pin

Arguments:

  This  - pointer to protocol
  Gpio  - which pin to modify
  Mode  - mode to set

Returns:

  EFI_SUCCESS - GPIO set as requested

--*/


typedef
EFI_STATUS
(EFIAPI *EMBEDDED_GPIO_GET_MODE) (
    IN  EMBEDDED_GPIO         *This,
    IN  EMBEDDED_GPIO_PIN     Gpio,
    OUT EMBEDDED_GPIO_MODE    *Mode
    );
/*++

Routine Description:

  Gets the mode (function) of a GPIO pin

Arguments:

  This  - pointer to protocol
  Gpio  - which pin
  Mode  - pointer to output mode value

Returns:

  EFI_SUCCESS - mode value retrieved

--*/


typedef
EFI_STATUS
(EFIAPI *EMBEDDED_GPIO_SET_PULL) (
    IN  EMBEDDED_GPIO      *This,
    IN  EMBEDDED_GPIO_PIN  Gpio,
    IN  EMBEDDED_GPIO_PULL Direction
    );
/*++

Routine Description:

  Sets the pull-up / pull-down resistor of a GPIO pin

Arguments:

  This  - pointer to protocol
  Gpio  - which pin
  Direction - pull-up, pull-down, or none

Returns:

  EFI_SUCCESS - pin was set

--*/



struct _EMBEDDED_GPIO {
  EMBEDDED_GPIO_GET       Get;
  EMBEDDED_GPIO_SET       Set;
  EMBEDDED_GPIO_GET_MODE  GetMode;
  EMBEDDED_GPIO_SET_PULL  SetPull;
};

extern EFI_GUID gEmbeddedGpioProtocolGuid;

typedef struct _GPIO_CONTROLLER              GPIO_CONTROLLER;
typedef struct _PLATFORM_GPIO_CONTROLLER     PLATFORM_GPIO_CONTROLLER;

struct _GPIO_CONTROLLER {
  UINTN                   RegisterBase;
  UINTN                   GpioIndex;
  UINTN                   InternalGpioCount;
};

struct _PLATFORM_GPIO_CONTROLLER {
  UINTN                   GpioCount;
  UINTN                   GpioControllerCount;
  GPIO_CONTROLLER         *GpioController;
};

extern EFI_GUID gPlatformGpioProtocolGuid;

#endif