pinmap.h

Go to the documentation of this file.

/*
Copyright (c) 2023 Eindhoven University of Technology
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#ifndef PINMAP_H
#define PINMAP_H
 
#define NUM_ANALOG_REFERENCE_PINS 14 /* # analog reference pins */
#define NUM_ANALOG_IN_PINS 6         /* # analog input pins */
 
typedef enum {
  IO_AR0 = 0,   /* reference pin 0 */
  IO_AR1 = 1,   /* reference pin 1 */
  IO_AR2 = 2,   /* reference pin 2 */
  IO_AR3 = 3,   /* reference pin 3 */
  IO_AR4 = 4,   /* reference pin 4 */
  IO_AR5 = 5,   /* reference pin 5 */
  IO_AR6 = 6,   /* reference pin 6 */
  IO_AR7 = 7,   /* reference pin 7 */
  IO_AR8 = 8,   /* reference pin 8 */
  IO_AR9 = 9,   /* reference pin 9 */
  IO_AR10 = 10, /* reference pin 10 */
  IO_AR11 = 11, /* reference pin 11 */
  IO_AR12 = 12, /* reference pin 12 */
  IO_AR13 = 13, /* reference pin 13 */
 
  IO_A0 = 14, /* analog input pin 0 */
  IO_A1 = 15, /* analog input pin 1 */
  IO_A2 = 16, /* analog input pin 2 */
  IO_A3 = 17, /* analog input pin 3 */
  IO_A4 = 18, /* analog input pin 4 */
  IO_A5 = 19, /* analog input pin 5 */
 
  IO_SW0 = 20, /* switch input pin 0 */
  IO_SW1 = 21, /* switch input pin 1 */
 
  IO_BTN0 = 22, /* button input pin 0 */
  IO_BTN1 = 23, /* button input pin 1 */
  IO_BTN2 = 24, /* button input pin 2 */
  IO_BTN3 = 25, /* button input pin 3 */
 
  IO_LD0 = 26, /* LED output pin 0 */
  IO_LD1 = 27, /* LED output pin 1 */
  IO_LD2 = 28, /* LED output pin 2 */
  IO_LD3 = 29, /* LED output pin 3 */
 
  IO_AR_SCL = 31, /* I2C clock pin */
  IO_AR_SDA = 30, /* I2C data pin */
 
  IO_LD4B = 32, /* color LED 0 blue input pin */
  IO_LD4R = 33, /* color LED 0 red input pin */
  IO_LD4G = 34, /* color LED 0 green input pin */
 
  IO_LD5B = 35, /* color LED 1 blue input pin */
  IO_LD5R = 36, /* color LED 1 red input pin */
  IO_LD5G = 37, /* color LED 1 green input pin */
 
  IO_RBPI40 = 38, /* RaspberryPi header pin */
  IO_RBPI37 = 39, /* RaspberryPi header pin */
  IO_RBPI38 = 40, /* RaspberryPi header pin */
  IO_RBPI35 = 41, /* RaspberryPi header pin */
  IO_RBPI36 = 42, /* RaspberryPi header pin */
  IO_RBPI33 = 43, /* RaspberryPi header pin */
  IO_RBPI18 = 44, /* RaspberryPi header pin */
  IO_RBPI32 = 45, /* RaspberryPi header pin */
  IO_RBPI10 = 46, /* RaspberryPi header pin */
  IO_RBPI27 = 47, /* RaspberryPi header pin */
  IO_RBPI28 = 48, /* RaspberryPi header pin */
  IO_RBPI22 = 49, /* RaspberryPi header pin */
  IO_RBPI23 = 50, /* RaspberryPi header pin */
  IO_RBPI24 = 51, /* RaspberryPi header pin */
  IO_RBPI21 = 52, /* RaspberryPi header pin */
  IO_RBPI26 = 53, /* RaspberryPi header pin */
  IO_RBPI19 = 54, /* RaspberryPi header pin */
  IO_RBPI31 = 55, /* RaspberryPi header pin */
  IO_RBPI15 = 56, /* RaspberryPi header pin */
  IO_RBPI16 = 57, /* RaspberryPi header pin */
  IO_RBPI13 = 58, /* RaspberryPi header pin */
  IO_RBPI12 = 59, /* RaspberryPi header pin */
  IO_RBPI29 = 60, /* RaspberryPi header pin */
  IO_RBPI08 = 61, /* RaspberryPi header pin */
  IO_RBPI07 = 62, /* RaspberryPi header pin */
  IO_RBPI05 = 63, /* RaspberryPi header pin */
 
  IO_NUM_PINS = 64,
} io_t;
 
#define IO_PMODA1       IO_RBPI07
#define IO_PMODA2       IO_RBPI29
#define IO_PMODA3       IO_RBPI27
#define IO_PMODA4       IO_RBPI28
#define IO_PMODA7       IO_RBPI31
#define IO_PMODA8       IO_RBPI26
 
#define PIN_CHECK(pin)                                                         \
  do {                                                                         \
    if (pin >= IO_NUM_PINS) {                                                  \
      pynq_error("pin %u is invalid, must be 0..%u-1.\n", pin, IO_NUM_PINS);   \
    }                                                                          \
  } while (0);
 
extern char *const pin_names[64];
#endif // PINMAP_H