Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 1 | /* |
| 2 | * This file is part of the coreboot project. |
| 3 | * |
| 4 | * Copyright 2014 Google Inc. |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; version 2 of the License. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 14 | */ |
| 15 | |
Julius Werner | eaa9c45 | 2014-09-24 15:40:49 -0700 | [diff] [blame] | 16 | #ifndef __SRC_INCLUDE_GPIO_H__ |
| 17 | #define __SRC_INCLUDE_GPIO_H__ |
Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 18 | |
Julius Werner | eaa9c45 | 2014-09-24 15:40:49 -0700 | [diff] [blame] | 19 | #include <soc/gpio.h> |
| 20 | #include <types.h> |
| 21 | |
| 22 | /* <soc/gpio.h> must typedef a gpio_t that fits in 32 bits. */ |
| 23 | _Static_assert(sizeof(gpio_t) <= sizeof(u32), "gpio_t doesn't fit in lb_gpio"); |
| 24 | |
| 25 | /* The following functions must be implemented by SoC/board code. */ |
| 26 | int gpio_get(gpio_t gpio); |
| 27 | void gpio_set(gpio_t gpio, int value); |
| 28 | void gpio_input_pulldown(gpio_t gpio); |
| 29 | void gpio_input_pullup(gpio_t gpio); |
| 30 | void gpio_input(gpio_t gpio); |
| 31 | void gpio_output(gpio_t gpio, int value); |
Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 32 | |
| 33 | /* |
| 34 | * Read the value presented by the set of GPIOs, when each pin is interpreted |
David Hendricks | 21db62e | 2014-11-06 15:05:35 -0800 | [diff] [blame] | 35 | * as a base-2 digit (LOW = 0, HIGH = 1). |
| 36 | * |
| 37 | * gpio[]: pin positions to read. gpio[0] is less significant than gpio[1]. |
| 38 | * num_gpio: number of pins to read. |
| 39 | */ |
| 40 | int gpio_base2_value(gpio_t gpio[], int num_gpio); |
| 41 | |
| 42 | /* |
| 43 | * Read the value presented by the set of GPIOs, when each pin is interpreted |
Julius Werner | 886d29b | 2014-09-24 15:40:49 -0700 | [diff] [blame] | 44 | * as a base-3 digit (LOW = 0, HIGH = 1, Z/floating = 2). |
David Hendricks | 3fc6368 | 2014-11-06 15:09:27 -0800 | [diff] [blame] | 45 | * Example: X1 = Z, X2 = 1 -> gpio_base3_value({GPIO(X1), GPIO(X2)}) = 5 |
Julius Werner | 886d29b | 2014-09-24 15:40:49 -0700 | [diff] [blame] | 46 | * BASE3() from <base3.h> can generate numbers to compare the result to. |
Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 47 | * |
Julius Werner | 886d29b | 2014-09-24 15:40:49 -0700 | [diff] [blame] | 48 | * gpio[]: pin positions to read. gpio[0] is less significant than gpio[1]. |
Daisuke Nojiri | 573e211 | 2014-08-08 15:38:52 -0700 | [diff] [blame] | 49 | * num_gpio: number of pins to read. |
Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 50 | */ |
David Hendricks | 3fc6368 | 2014-11-06 15:09:27 -0800 | [diff] [blame] | 51 | int gpio_base3_value(gpio_t gpio[], int num_gpio); |
Vadim Bendebury | 9c9c336 | 2014-07-23 09:40:02 -0700 | [diff] [blame] | 52 | |
Julius Werner | eaa9c45 | 2014-09-24 15:40:49 -0700 | [diff] [blame] | 53 | #endif /* __SRC_INCLUDE_GPIO_H__ */ |