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