src/southbridge/intel/fsp_i89xx/gpio.h

   1 /*
   2  * This file is part of the coreboot project.
   3  *
   4  * Copyright (C) 2011 The Chromium OS Authors. All rights reserved.
   5  * Copyright (C) 2013 Sage Electronic Engineering, LLC.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; version 2 of the License.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  */
  16
  17 #ifndef INTEL_I89XX_GPIO_H
  18 #define INTEL_I89XX_GPIO_H
  19
  20 #include <compiler.h>
  21
  22 #define GPIO_MODE_NATIVE        0
  23 #define GPIO_MODE_GPIO          1
  24 #define GPIO_MODE_NONE          1
  25
  26 #define GPIO_DIR_OUTPUT         0
  27 #define GPIO_DIR_INPUT          1
  28
  29 #define GPIO_NO_INVERT          0
  30 #define GPIO_INVERT             1
  31
  32 #define GPIO_LEVEL_LOW          0
  33 #define GPIO_LEVEL_HIGH         1
  34
  35 #define GPIO_NO_BLINK           0
  36 #define GPIO_BLINK              1
  37
  38 #define GPIO_RESET_PWROK        0
  39 #define GPIO_RESET_RSMRST       1
  40
  41 struct pch_gpio_set1 {
  42         u32 gpio0 : 1;
  43         u32 gpio1 : 1;
  44         u32 gpio2 : 1;
  45         u32 gpio3 : 1;
  46         u32 gpio4 : 1;
  47         u32 gpio5 : 1;
  48         u32 gpio6 : 1;
  49         u32 gpio7 : 1;
  50         u32 gpio8 : 1;
  51         u32 gpio9 : 1;
  52         u32 gpio10 : 1;
  53         u32 gpio11 : 1;
  54         u32 gpio12 : 1;
  55         u32 gpio13 : 1;
  56         u32 gpio14 : 1;
  57         u32 gpio15 : 1;
  58         u32 gpio16 : 1;
  59         u32 gpio17 : 1;
  60         u32 gpio18 : 1;
  61         u32 gpio19 : 1;
  62         u32 gpio20 : 1;
  63         u32 gpio21 : 1;
  64         u32 gpio22 : 1;
  65         u32 gpio23 : 1;
  66         u32 gpio24 : 1;
  67         u32 gpio25 : 1;
  68         u32 gpio26 : 1;
  69         u32 gpio27 : 1;
  70         u32 gpio28 : 1;
  71         u32 gpio29 : 1;
  72         u32 gpio30 : 1;
  73         u32 gpio31 : 1;
  74 } __packed;
  75
  76 struct pch_gpio_set2 {
  77         u32 gpio32 : 1;
  78         u32 gpio33 : 1;
  79         u32 gpio34 : 1;
  80         u32 gpio35 : 1;
  81         u32 gpio36 : 1;
  82         u32 gpio37 : 1;
  83         u32 gpio38 : 1;
  84         u32 gpio39 : 1;
  85         u32 gpio40 : 1;
  86         u32 gpio41 : 1;
  87         u32 gpio42 : 1;
  88         u32 gpio43 : 1;
  89         u32 gpio44 : 1;
  90         u32 gpio45 : 1;
  91         u32 gpio46 : 1;
  92         u32 gpio47 : 1;
  93         u32 gpio48 : 1;
  94         u32 gpio49 : 1;
  95         u32 gpio50 : 1;
  96         u32 gpio51 : 1;
  97         u32 gpio52 : 1;
  98         u32 gpio53 : 1;
  99         u32 gpio54 : 1;
 100         u32 gpio55 : 1;
 101         u32 gpio56 : 1;
 102         u32 gpio57 : 1;
 103         u32 gpio58 : 1;
 104         u32 gpio59 : 1;
 105         u32 gpio60 : 1;
 106         u32 gpio61 : 1;
 107         u32 gpio62 : 1;
 108         u32 gpio63 : 1;
 109 } __packed;
 110
 111 struct pch_gpio_set3 {
 112         u32 gpio64 : 1;
 113         u32 gpio65 : 1;
 114         u32 gpio66 : 1;
 115         u32 gpio67 : 1;
 116         u32 gpio68 : 1;
 117         u32 gpio69 : 1;
 118         u32 gpio70 : 1;
 119         u32 gpio71 : 1;
 120         u32 gpio72 : 1;
 121         u32 gpio73 : 1;
 122         u32 gpio74 : 1;
 123         u32 gpio75 : 1;
 124         u32 fill_bitfield : 20;
 125 } __packed;
 126
 127 struct pch_gpio_map {
 128         union {
 129         struct {
 130                 const struct pch_gpio_set1 *mode;
 131                 const struct pch_gpio_set1 *direction;
 132                 const struct pch_gpio_set1 *level;
 133                 const struct pch_gpio_set1 *reset;
 134                 const struct pch_gpio_set1 *invert;
 135                 const struct pch_gpio_set1 *blink;
 136         } set1;
 137         struct {
 138                         const u32 *mode;
 139                         const u32 *direction;
 140                         const u32 *level;
 141                         const u32 *reset;
 142                         const u32 *invert;
 143                         const u32 *blink;
 144                 } set1_vals;
 145         };
 146
 147         union {
 148                 struct {
 149                 const struct pch_gpio_set2 *mode;
 150                 const struct pch_gpio_set2 *direction;
 151                 const struct pch_gpio_set2 *level;
 152                 const struct pch_gpio_set2 *reset;
 153         } set2;
 154         struct {
 155                         const u32 *mode;
 156                         const u32 *direction;
 157                         const u32 *level;
 158                         const u32 *reset;
 159                 } set2_vals;
 160         };
 161
 162         union {
 163                 struct {
 164                 const struct pch_gpio_set3 *mode;
 165                 const struct pch_gpio_set3 *direction;
 166                 const struct pch_gpio_set3 *level;
 167                 const struct pch_gpio_set3 *reset;
 168         } set3;
 169                 struct {
 170                         const u32 *mode;
 171                         const u32 *direction;
 172                         const u32 *level;
 173                         const u32 *reset;
 174                 } set3_vals;
 175         };
 176 };
 177
 178 /* Configure GPIOs with mainboard provided settings */
 179 void setup_pch_gpios(const struct pch_gpio_map *gpio);
 180
 181 /* get GPIO and set pin values */
 182 int get_gpio(int gpio_num);
 183 void set_gpio(int gpio_num);
 184 void clear_gpio(int gpio_num);
 185
 186 /*
 187  * get a number comprised of multiple GPIO values. gpio_num_array points to
 188  * the array of gpio pin numbers to scan, terminated by -1.
 189  */
 190 unsigned get_gpios(const int *gpio_num_array);
 191
 192 #endif