src/adafruit_blinka/microcontroller/nxp_lpc4330/pin.py

   1 """NXP LPC4330 pin names"""
   2 try:
   3     from greatfet import GreatFET
   4     from greatfet.interfaces.adc import ADC
   5
   6     gf = GreatFET()
   7 except:
   8     raise RuntimeError(
   9         "Unable to create GreatFET object. Make sure library is installed and the device is connected."
  10     )
  11
  12
  13 class Pin:
  14     """A basic Pin class for the NXP LPC4330 that acts as a wrapper for the GreatFET api."""
  15
  16     # pin modes
  17     OUT = gf.gpio.DIRECTION_OUT
  18     IN = gf.gpio.DIRECTION_IN
  19     ADC = 2
  20     DAC = 3
  21
  22     # pin values
  23     LOW = 0
  24     HIGH = 1
  25
  26     def __init__(self, pin_id=None):
  27         self.id = pin_id
  28         self._mode = None
  29         self._pin = None
  30
  31     def init(self, mode=IN, pull=None):
  32         """Initialize the Pin"""
  33         if self.id is None:
  34             raise RuntimeError("Can not init a None type pin.")
  35         if mode in (Pin.IN, Pin.OUT):
  36             if self.id not in gf.GPIO_MAPPINGS:
  37                 raise ValueError("Pin does not have GPIO capabilities")
  38             self._pin = gf.gpio.get_pin(self.id)
  39             self._pin.set_direction(mode)
  40         elif mode == Pin.ADC:
  41             # ADC only available on these pins
  42             if self.id not in gf.ADC_MAPPINGS:
  43                 raise ValueError("Pin does not have ADC capabilities")
  44             gf.ADC_MAPPINGS[self.id]
  45             # TODO: figure out a way to pass the ADC number without breaking the interface
  46             self._pin = ADC(gf, self.id)
  47         elif mode == Pin.DAC:
  48             # DAC only available on these pins
  49             if self.id not in ("J2_P5"):
  50                 raise ValueError("Pin does not have DAC capabilities")
  51             self._pin = gf.apis.dac
  52             self._pin.initialize()
  53         else:
  54             raise ValueError("Incorrect pin mode: {}".format(mode))
  55         self._mode = mode
  56
  57     def value(self, val=None):
  58         """Set or return the Pin Value"""
  59         # Digital In / Out
  60         if self._mode in (Pin.IN, Pin.OUT):
  61             # digital read
  62             if val is None:
  63                 return self._pin.get_state()
  64             # digital write
  65             if val in (Pin.LOW, Pin.HIGH):
  66                 self._pin.set_state(val)
  67                 return None
  68             # nope
  69             raise ValueError("Invalid value for pin.")
  70         # Analog In
  71         if self._mode == Pin.ADC:
  72             if val is None:
  73                 # Read ADC here
  74                 return self._pin.read_samples()[0]
  75             # read only
  76             raise AttributeError("'AnalogIn' object has no attribute 'value'")
  77         # Analog Out
  78         if self._mode == Pin.DAC:
  79             if val is None:
  80                 # write only
  81                 raise AttributeError("unreadable attribute")
  82             # Set DAC Here
  83             self._pin.set_value(int(val))
  84             return None
  85         raise RuntimeError(
  86             "No action for mode {} with value {}".format(self._mode, val)
  87         )
  88
  89
  90 # create pin instances for each pin
  91 # J1 Header Pins
  92 J1_P3 = Pin("J1_P3")
  93 J1_P4 = Pin("J1_P4")
  94 J1_P5 = Pin("J1_P5")
  95 J1_P6 = Pin("J1_P6")
  96 J1_P7 = Pin("J1_P7")
  97 J1_P8 = Pin("J1_P8")
  98 J1_P9 = Pin("J1_P9")
  99 J1_P10 = Pin("J1_P10")
 100 J1_P12 = Pin("J1_P12")
 101 J1_P13 = Pin("J1_P13")
 102 J1_P14 = Pin("J1_P14")
 103 J1_P15 = Pin("J1_P15")
 104 J1_P16 = Pin("J1_P16")
 105 J1_P17 = Pin("J1_P17")
 106 J1_P18 = Pin("J1_P18")
 107 J1_P19 = Pin("J1_P19")
 108 J1_P20 = Pin("J1_P20")
 109 J1_P21 = Pin("J1_P21")
 110 J1_P22 = Pin("J1_P22")
 111 J1_P23 = Pin("J1_P23")
 112 J1_P24 = Pin("J1_P24")
 113 J1_P25 = Pin("J1_P25")
 114 J1_P26 = Pin("J1_P26")
 115 J1_P27 = Pin("J1_P27")
 116 J1_P28 = Pin("J1_P28")
 117 J1_P29 = Pin("J1_P29")
 118 J1_P30 = Pin("J1_P30")
 119 J1_P31 = Pin("J1_P31")
 120 J1_P32 = Pin("J1_P32")
 121 J1_P33 = Pin("J1_P33")
 122 J1_P34 = Pin("J1_P34")
 123 J1_P35 = Pin("J1_P35")
 124 J1_P37 = Pin("J1_P37")
 125 J1_P39 = Pin("J1_P39")  # MOSI
 126 J1_P40 = Pin("J1_P40")  # MISO
 127
 128
 129 # J2 Header Pins
 130 J2_P3 = Pin("J2_P3")
 131 J2_P4 = Pin("J2_P4")
 132 J2_P5 = Pin("J2_P5")  # ADC, ADC, DAC
 133 J2_P6 = Pin("J2_P6")
 134 J2_P7 = Pin("J2_P7")
 135 J2_P8 = Pin("J2_P8")
 136 J2_P9 = Pin("J2_P9")  # ADC, GPIO
 137 J2_P10 = Pin("J2_P10")
 138 J2_P13 = Pin("J2_P13")
 139 J2_P14 = Pin("J2_P14")
 140 J2_P15 = Pin("J2_P15")
 141 J2_P16 = Pin("J2_P16")  # GPIO, ADC
 142 J2_P18 = Pin("J2_P18")
 143 J2_P19 = Pin("J2_P19")
 144 J2_P20 = Pin("J2_P20")
 145 J2_P22 = Pin("J2_P22")
 146 J2_P23 = Pin("J2_P23")
 147 J2_P24 = Pin("J2_P24")
 148 J2_P25 = Pin("J2_P25")
 149 J2_P27 = Pin("J2_P27")
 150 J2_P28 = Pin("J2_P28")
 151 J2_P29 = Pin("J2_P29")
 152 J2_P30 = Pin("J2_P30")
 153 J2_P31 = Pin("J2_P31")
 154 J2_P33 = Pin("J2_P33")
 155 J2_P34 = Pin("J2_P34")
 156 J2_P35 = Pin("J2_P35")
 157 J2_P36 = Pin("J2_P36")
 158 J2_P37 = Pin("J2_P37")
 159 J2_P38 = Pin("J2_P38")
 160
 161 # Bonus Row Pins
 162 J7_P2 = Pin("J7_P2")
 163 J7_P3 = Pin("J7_P3")
 164 J7_P4 = Pin("J7_P4")  # ADC, ADC
 165 J7_P5 = Pin("J7_P5")  # ADC, ADC
 166 J7_P6 = Pin("J7_P6")
 167 J7_P7 = Pin("J7_P7")
 168 J7_P8 = Pin("J7_P8")
 169 J7_P13 = Pin("J7_P13")
 170 J7_P14 = Pin("J7_P14")
 171 J7_P15 = Pin("J7_P15")
 172 J7_P16 = Pin("J7_P16")
 173 J7_P17 = Pin("J7_P17")
 174 J7_P18 = Pin("J7_P18")
 175
 176 SCL = Pin()
 177 SDA = Pin()
 178
 179 SCK = Pin()
 180 MOSI = J1_P39
 181 MISO = J1_P40
 182
 183 TX = J1_P33
 184 RX = J1_P34
 185
 186 # ordered as uartId, txId, rxId
 187 uartPorts = ((0, TX, RX),)
 188
 189 # pwm outputs: pwm channel and pin
 190 pwmOuts = (
 191     (0, J1_P4),
 192     (1, J1_P6),
 193     (2, J1_P28),
 194     (3, J1_P30),
 195     (4, J2_P36),
 196     (5, J2_P34),
 197     (6, J2_P33),
 198     (7, J1_P34),
 199     (8, J2_P9),
 200     (9, J1_P6),
 201     (10, J1_P25),
 202     (11, J1_P32),
 203     (12, J1_P31),
 204     (13, J2_P3),
 205     (14, J1_P3),
 206     (15, J1_P5),
 207 )