]> Repositories - Adafruit_Blinka-hackapet.git/blob - src/busio.py
Add first commit for AllWinner A64 chip.
[Adafruit_Blinka-hackapet.git] / src / busio.py
1 """
2 `busio` - Bus protocol support like I2C and SPI
3 =================================================
4
5 See `CircuitPython:busio` in CircuitPython for more details.
6
7 * Author(s): cefn
8 """
9
10 import threading
11
12 from adafruit_blinka import Enum, Lockable, agnostic
13 from adafruit_blinka.agnostic import board_id, detector
14 import adafruit_platformdetect.board as ap_board
15
16 class I2C(Lockable):
17     def __init__(self, scl, sda, frequency=400000):
18         self.init(scl, sda, frequency)
19
20     def init(self, scl, sda, frequency):
21         self.deinit()
22         if detector.board.ftdi_ft232h:
23             from adafruit_blinka.microcontroller.ft232h.i2c import I2C
24             self._i2c = I2C(frequency=frequency)
25             return
26         elif detector.board.binho_nova:
27             from adafruit_blinka.microcontroller.nova.i2c import I2C
28         elif detector.board.microchip_mcp2221:
29             from adafruit_blinka.microcontroller.mcp2221.i2c import I2C
30             self._i2c = I2C(frequency=frequency)
31             return
32         elif detector.board.any_embedded_linux:
33             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
34         else:
35             from machine import I2C as _I2C
36         from microcontroller.pin import i2cPorts
37         for portId, portScl, portSda in i2cPorts:
38             try:
39                 if scl == portScl and sda == portSda:
40                     self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
41                     break
42             except RuntimeError:
43                 pass
44         else:
45             raise ValueError(
46                 "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format((scl, sda), i2cPorts)
47             )
48
49         self._lock = threading.RLock()
50
51     def deinit(self):
52         try:
53             del self._i2c
54         except AttributeError:
55             pass
56
57     def __enter__(self):
58         self._lock.acquire()
59         return self
60
61     def __exit__(self, exc_type, exc_value, traceback):
62         self._lock.release()
63         self.deinit()
64
65     def scan(self):
66         return self._i2c.scan()
67
68     def readfrom_into(self, address, buffer, *, start=0, end=None):
69         if start is not 0 or end is not None:
70             if end is None:
71                 end = len(buffer)
72             buffer = memoryview(buffer)[start:end]
73         stop = True  # remove for efficiency later
74         return self._i2c.readfrom_into(address, buffer, stop=stop)
75
76     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
77         if isinstance(buffer, str):
78             buffer = bytes([ord(x) for x in buffer])
79         if start is not 0 or end is not None:
80             if end is None:
81                 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
82             else:
83                 return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
84         return self._i2c.writeto(address, buffer, stop=stop)
85
86     def writeto_then_readfrom(self, address, buffer_out, buffer_in, *, out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
87         return self._i2c.writeto_then_readfrom(address, buffer_out, buffer_in,
88                                                out_start=out_start, out_end=out_end,
89                                                in_start=in_start, in_end=in_end, stop=stop)
90
91 class SPI(Lockable):
92     def __init__(self, clock, MOSI=None, MISO=None):
93         self.deinit()
94         if detector.board.ftdi_ft232h:
95             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
96             from adafruit_blinka.microcontroller.ft232h.pin import SCK, MOSI, MISO
97             self._spi = _SPI()
98             self._pins = (SCK, MOSI, MISO)
99             return
100         elif detector.board.binho_nova:
101             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
102             from adafruit_blinka.microcontroller.nova.pin import SCK, MOSI, MISO
103             self._spi = _SPI(clock)
104             self._pins = (SCK, MOSI, MISO)
105             return
106         elif detector.board.any_embedded_linux:
107             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
108         else:
109             from machine import SPI as _SPI
110         from microcontroller.pin import spiPorts
111         for portId, portSck, portMosi, portMiso in spiPorts:
112             if ((clock == portSck) and                   # Clock is required!
113                 (MOSI == portMosi or MOSI == None) and   # But can do with just output
114                 (MISO == portMiso or MISO == None)):      # Or just input
115                 self._spi = _SPI(portId)
116                 self._pins = (portSck, portMosi, portMiso)
117                 break
118         else:
119             raise ValueError(
120                 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".
121                 format((clock, MOSI, MISO), spiPorts))
122
123     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
124         if detector.board.any_raspberry_pi or detector.board.any_raspberry_pi_40_pin:
125             from adafruit_blinka.microcontroller.bcm283x.pin import Pin
126             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
127         elif detector.board.any_beaglebone:
128             from adafruit_blinka.microcontroller.am335x.pin import Pin
129             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
130         elif board_id == ap_board.ORANGE_PI_PC or board_id == ap_board.ORANGE_PI_R1 or board_id == ap_board.ORANGE_PI_ZERO:
131             from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
132             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
133         elif board_id == ap_board.GIANT_BOARD:
134             from adafruit_blinka.microcontroller.sama5.pin import Pin
135             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
136         elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
137             from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
138             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
139         elif board_id == ap_board.ODROID_C2:
140             from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
141             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
142         elif board_id == ap_board.DRAGONBOARD_410C:
143             from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
144             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
145         elif board_id == ap_board.JETSON_NANO:
146             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
147             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
148         elif board_id == ap_board.JETSON_TX1:
149             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
150             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
151         elif board_id == ap_board.JETSON_TX2:
152             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
153             from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
154         elif board_id == ap_board.JETSON_XAVIER:
155             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
156             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
157         elif detector.board.ftdi_ft232h:
158             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
159             from adafruit_blinka.microcontroller.ft232h.pin import Pin
160         elif detector.board.binho_nova:
161             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
162             from adafruit_blinka.microcontroller.nova.pin import Pin
163         else:
164             from machine import SPI as _SPI
165             from machine import Pin
166
167         if self._locked:
168             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
169             self._spi.init(
170                 baudrate=baudrate,
171                 polarity=polarity,
172                 phase=phase,
173                 bits=bits,
174                 firstbit=_SPI.MSB,
175                 sck=Pin(self._pins[0].id),
176                 mosi=Pin(self._pins[1].id),
177                 miso=Pin(self._pins[2].id)
178             )
179         else:
180             raise RuntimeError("First call try_lock()")
181
182     def deinit(self):
183         self._spi = None
184         self._pinIds = None
185
186     @property
187     def frequency(self):
188         try:
189             return self._spi.frequency
190         except AttributeError:
191             raise NotImplementedError("Frequency attribute not implemented for this platform")
192
193     def write(self, buf, start=0, end=None):
194         return self._spi.write(buf, start, end)
195
196     def readinto(self, buf, start=0, end=None, write_value=0):
197         return self._spi.readinto(buf, start, end, write_value=write_value)
198
199     def write_readinto(self, buffer_out, buffer_in,  out_start=0, out_end=None, in_start=0, in_end=None):
200         return self._spi.write_readinto(buffer_out, buffer_in, out_start, out_end, in_start, in_end)
201
202
203 class UART(Lockable):
204     class Parity(Enum):
205         pass
206
207     Parity.ODD = Parity()
208     Parity.EVEN = Parity()
209
210     def __init__(self,
211                  tx,
212                  rx,
213                  baudrate=9600,
214                  bits=8,
215                  parity=None,
216                  stop=1,
217                  timeout=1000,
218                  receiver_buffer_size=64,
219                  flow=None):
220         if detector.board.any_embedded_linux:
221             raise RuntimeError('busio.UART not supported on this platform. Please use pyserial instead.')
222         elif detector.board.binho_nova:
223             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
224         else:
225             from machine import UART as _UART
226
227         if detector.board.binho_nova:
228             from adafruit_blinka.microcontroller.nova.pin import uartPorts
229         else:
230             from microcontroller.pin import uartPorts
231
232         self.baudrate = baudrate
233
234         if flow is not None:  # default 0
235             raise NotImplementedError(
236                 "Parameter '{}' unsupported on {}".format(
237                     "flow", agnostic.board_id))
238
239         # translate parity flag for Micropython
240         if parity is UART.Parity.ODD:
241             parity = 1
242         elif parity is UART.Parity.EVEN:
243             parity = 0
244         elif parity is None:
245             pass
246         else:
247             raise ValueError("Invalid parity")
248
249         # check tx and rx have hardware support
250         for portId, portTx, portRx in uartPorts:  #
251             if portTx == tx and portRx == rx:
252                 self._uart = _UART(
253                     portId,
254                     baudrate,
255                     bits=bits,
256                     parity=parity,
257                     stop=stop,
258                     timeout=timeout,
259                     read_buf_len=receiver_buffer_size
260                 )
261                 break
262         else:
263             raise ValueError(
264                 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format((tx, rx), uartPorts)
265             )
266
267     def deinit(self):
268         if detector.board.binho_nova:
269             self._uart.deinit()
270         self._uart = None
271
272     def read(self, nbytes=None):
273         return self._uart.read(nbytes)
274
275     def readinto(self, buf, nbytes=None):
276         return self._uart.readinto(buf, nbytes)
277
278     def readline(self):
279         return self._uart.readline()
280
281     def write(self, buf):
282         return self._uart.write(buf)