summaryrefslogtreecommitdiff
path: root/Adafruit_Python_GPIO/tests/test_SPI.py
blob: 123eec1c07dbde30b7ba604965bfe78cd5b6167e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# Copyright (c) 2014 Adafruit Industries
# Author: Tony DiCola
#
# 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.

import unittest

import Adafruit_GPIO as GPIO
import Adafruit_GPIO.SPI as SPI

from MockGPIO import MockGPIO


class TestBitBangSPI(unittest.TestCase):
    def test_pin_modes_set_correctly(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        self.assertDictEqual(gpio.pin_mode, { 1: GPIO.OUT,
                                              2: GPIO.OUT,
                                              3: GPIO.IN,
                                              4: GPIO.OUT })

    def test_ss_set_high_after_initialization(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        self.assertListEqual(gpio.pin_written[4], [1])

    def test_mode_0_write(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        device.write([0x1F])
        # Verify clock
        self.assertListEqual(gpio.pin_written[1], [0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1, 0])
        # Verify MOSI
        self.assertListEqual(gpio.pin_written[2], [0, 0, 0, 1, 1, 1, 1, 1])
        # Verify MISO
        self.assertNotIn(3, gpio.pin_written)
        # Verify SS
        self.assertListEqual(gpio.pin_written[4], [1, 0, 1])

    def test_write_assert_deassert_ss_false(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        device.write([0x1F], assert_ss=False, deassert_ss=False)
        self.assertListEqual(gpio.pin_written[4], [1])

    def test_write_lsbfirst(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        device.set_bit_order(SPI.LSBFIRST)
        device.write([0x1F])
        self.assertListEqual(gpio.pin_written[2], [1, 1, 1, 1, 1, 0, 0, 0])

    def test_invalid_mode_fails(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        self.assertRaises(ValueError, device.set_mode, -1)
        self.assertRaises(ValueError, device.set_mode, 4)

    def test_invalid_bit_order_fails(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        self.assertRaises(ValueError, device.set_bit_order, -1)
        self.assertRaises(ValueError, device.set_bit_order, 2)

    def test_mode_0_read(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        gpio.pin_read[3] = [0, 0, 0, 1, 1, 1, 1, 1]
        result = device.read(1)
        # Verify clock
        self.assertListEqual(gpio.pin_written[1], [0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1, 0])
        # Verify MOSI
        self.assertNotIn(2, gpio.pin_written)
        # Verify MISO
        self.assertNotIn(3, gpio.pin_written)
        # Verify SS
        self.assertListEqual(gpio.pin_written[4], [1, 0, 1])
        # Verify result
        self.assertEqual(result, bytearray([0x1F]))

    def test_read_assert_deassert_ss_false(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        gpio.pin_read[3] = [0, 0, 0, 1, 1, 1, 1, 1]
        result = device.read(1, assert_ss=False, deassert_ss=False)
        self.assertListEqual(gpio.pin_written[4], [1])

    def test_read_multiple_bytes(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        gpio.pin_read[3] = [0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0,
                            0, 0, 0, 1, 1, 1, 1, 1]
        result = device.read(3)
        # Verify clock
        self.assertListEqual(gpio.pin_written[1], [0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1, 0])
        # Verify MOSI
        self.assertNotIn(2, gpio.pin_written)
        # Verify MISO
        self.assertNotIn(3, gpio.pin_written)
        # Verify SS
        self.assertListEqual(gpio.pin_written[4], [1, 0, 1])
        # Verify result
        self.assertEqual(result, bytearray([0x1F, 0xF8, 0x1F]))

    def test_write_multiple_bytes(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        device.write([0x1F, 0xF8, 0x1F])
        # Verify clock
        self.assertListEqual(gpio.pin_written[1], [0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1, 0])
        # Verify MOSI
        self.assertListEqual(gpio.pin_written[2], [0, 0, 0, 1, 1, 1, 1, 1,
                                                   1, 1, 1, 1, 1, 0, 0, 0,
                                                   0, 0, 0, 1, 1, 1, 1, 1])
        # Verify MISO
        self.assertNotIn(3, gpio.pin_written)
        # Verify SS
        self.assertListEqual(gpio.pin_written[4], [1, 0, 1])

    def test_mode_0_transfer(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        gpio.pin_read[3] = [0, 0, 0, 1, 1, 1, 1, 1]
        result = device.transfer([0xF8])
        # Verify clock
        self.assertListEqual(gpio.pin_written[1], [0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1, 0])
        # Verify MOSI
        self.assertListEqual(gpio.pin_written[2], [1, 1, 1, 1, 1, 0, 0, 0])
        # Verify MISO
        self.assertNotIn(3, gpio.pin_written)
        # Verify SS
        self.assertListEqual(gpio.pin_written[4], [1, 0, 1])
        # Verify result
        self.assertEqual(result, bytearray([0x1F]))

    def test_transfer_multiple_bytes(self):
        gpio = MockGPIO()
        device = SPI.BitBang(gpio, 1, 2, 3, 4)
        gpio.pin_read[3] = [0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0,
                            0, 0, 0, 1, 1, 1, 1, 1]
        result = device.transfer([0xF8, 0x1F, 0xF8])
        # Verify clock
        self.assertListEqual(gpio.pin_written[1], [0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1,
                                                   0, 1, 0, 1, 0, 1, 0, 1, 0])
        # Verify MOSI
        self.assertListEqual(gpio.pin_written[2], [1, 1, 1, 1, 1, 0, 0, 0,
                                                   0, 0, 0, 1, 1, 1, 1, 1,
                                                   1, 1, 1, 1, 1, 0, 0, 0])
        # Verify MISO
        self.assertNotIn(3, gpio.pin_written)
        # Verify SS
        self.assertListEqual(gpio.pin_written[4], [1, 0, 1])
        # Verify result
        self.assertEqual(result, bytearray([0x1F, 0xF8, 0x1F]))

    #TODO: Test mode 1, 2, 3

    #TODO: Test null MOSI, MISO, SS