mraa mock: Add SPI functionality

Signed-off-by: Alex Tereschenko <alext.mkrs@gmail.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>

tests/mock/CMakeLists.txt

@@ -22,6 +22,14 @@ add_test (NAME py_i2c_read_bytes_data COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMA
 add_test (NAME py_i2c_read_word_data COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/i2c_checks_read_word_data.py)
 add_test (NAME py_i2c_write_word_data COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/i2c_checks_write_word_data.py)
 
+add_test (NAME py_spi_bit_per_word COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_bit_per_word.py)
+add_test (NAME py_spi_checks_lsbmode COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_lsbmode.py)
+add_test (NAME py_spi_checks_mode COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_mode.py)
+add_test (NAME py_spi_checks_freq COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_freq.py)
+add_test (NAME py_spi_checks_write_byte COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_write_byte.py)
+add_test (NAME py_spi_checks_write_word COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_write_word.py)
+add_test (NAME py_spi_checks_write COMMAND ${PYTHON_DEFAULT_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/spi_checks_write.py)
+
 set_tests_properties(py_general
                      py_platform
                      py_gpio_basic
@@ -42,4 +50,11 @@ set_tests_properties(py_general
                      py_i2c_read_bytes_data
                      py_i2c_read_word_data
                      py_i2c_write_word_data
+                     py_spi_bit_per_word
+                     py_spi_checks_lsbmode
+                     py_spi_checks_mode
+                     py_spi_checks_freq
+                     py_spi_checks_write_byte
+                     py_spi_checks_write_word
+                     py_spi_checks_write
                      PROPERTIES ENVIRONMENT "PYTHONPATH=${PYTHON_DEFAULT_PYTHONPATH}")

tests/mock/platform_checks.py

@@ -27,7 +27,7 @@
 import mraa as m
 import unittest as u
 
-PLATFORM_PINCOUNT = 4
+PLATFORM_PINCOUNT = 8
 PLATFORM_STD_ADC_RES_BITS = 10
 PLATFORM_MAX_ADC_RES_BITS = 12
 

tests/mock/spi_checks_bit_per_word.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksBitPerWord(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_bit_per_word(self):
+    TEST_BIT_PER_WORD = 16
+    self.assertEqual(self.spi.bitPerWord(TEST_BIT_PER_WORD),
+                     m.SUCCESS,
+                     "Setting bit per word to %d did not return success" %TEST_BIT_PER_WORD)
+
+  def test_i2c_frequency_invalid_smaller_than_min(self):
+    TEST_BIT_PER_WORD = -100
+    self.assertRaises(OverflowError, self.spi.bitPerWord, TEST_BIT_PER_WORD)
+
+if __name__ == "__main__":
+  u.main()

tests/mock/spi_checks_freq.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksFreq(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_set_freq(self):
+    TEST_FREQ = 20000000
+    self.assertEqual(self.spi.frequency(TEST_FREQ),
+                     m.SUCCESS,
+                     "Setting SPI frequency to %d did not return success" %TEST_FREQ)
+
+  def test_spi_set_freq_invalid_smaller_than_min_zero(self):
+    TEST_FREQ = 0
+    self.assertEqual(self.spi.frequency(TEST_FREQ),
+                     m.ERROR_INVALID_PARAMETER,
+                     "Setting SPI frequency to %d did not return error" %TEST_FREQ)
+
+  def test_spi_set_freq_invalid_smaller_than_min_negative(self):
+    TEST_FREQ = -10
+    self.assertEqual(self.spi.frequency(TEST_FREQ),
+                     m.ERROR_INVALID_PARAMETER,
+                     "Setting SPI frequency to %d did not return error" %TEST_FREQ)
+
+if __name__ == "__main__":
+  u.main()

tests/mock/spi_checks_lsbmode.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksLsbmode(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_set_lsbmode_false(self):
+    TEST_LSBMODE = False
+    self.assertEqual(self.spi.lsbmode(TEST_LSBMODE),
+                     m.SUCCESS,
+                     "Setting LSB mode to %s did not return success" %TEST_LSBMODE)
+
+  def test_spi_set_lsbmode_true(self):
+    TEST_LSBMODE = True
+    self.assertEqual(self.spi.lsbmode(TEST_LSBMODE),
+                     m.SUCCESS,
+                     "Setting LSB mode to %s did not return success" %TEST_LSBMODE)
+
+  def test_spi_set_lsbmode_invalid(self):
+    TEST_LSBMODE = 10
+    self.assertRaises(TypeError, self.spi.lsbmode, TEST_LSBMODE)
+
+
+if __name__ == "__main__":
+  u.main()

tests/mock/spi_checks_mode.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksMode(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_set_mode_MODE0(self):
+    TEST_MODE = m.SPI_MODE0
+    self.assertEqual(self.spi.mode(TEST_MODE),
+                     m.SUCCESS,
+                     "Setting SPI mode to %d did not return success" %TEST_MODE)
+
+  def test_spi_set_mode_MODE1(self):
+    TEST_MODE = m.SPI_MODE1
+    self.assertEqual(self.spi.mode(TEST_MODE),
+                     m.SUCCESS,
+                     "Setting SPI mode to %d did not return success" %TEST_MODE)
+
+  def test_spi_set_mode_MODE2(self):
+    TEST_MODE = m.SPI_MODE2
+    self.assertEqual(self.spi.mode(TEST_MODE),
+                     m.SUCCESS,
+                     "Setting SPI mode to %d did not return success" %TEST_MODE)
+
+  def test_spi_set_mode_MODE3(self):
+    TEST_MODE = m.SPI_MODE3
+    self.assertEqual(self.spi.mode(TEST_MODE),
+                     m.SUCCESS,
+                     "Setting SPI mode to %d did not return success" %TEST_MODE)
+
+  def test_spi_set_mode_invalid_smaller_than_min(self):
+    TEST_MODE = -10
+    self.assertEqual(self.spi.mode(TEST_MODE),
+                     m.ERROR_INVALID_PARAMETER,
+                     "Setting SPI mode to %d did not return error" %TEST_MODE)
+
+  def test_spi_set_mode_invalid_bigger_than_max(self):
+    TEST_MODE = 150
+    self.assertEqual(self.spi.mode(TEST_MODE),
+                     m.ERROR_INVALID_PARAMETER,
+                     "Setting SPI mode to %d did not return error" %TEST_MODE)
+
+if __name__ == "__main__":
+  u.main()

tests/mock/spi_checks_shared.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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.
+
+MRAA_SPI_BUS_NUM = 0
+MOCK_SPI_REPLY_DATA_MODIFIER_BYTE = 0xAB
+MOCK_SPI_REPLY_DATA_MODIFIER_WORD = 0xABBA
+MOCK_SPI_TEST_DATA_LEN = 5

tests/mock/spi_checks_write.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksWrite(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_write(self):
+    DATA_TO_WRITE = bytearray([0xEE for i in range(MOCK_SPI_TEST_DATA_LEN)])
+    DATA_TO_EXPECT = bytearray([0xEE ^ MOCK_SPI_REPLY_DATA_MODIFIER_BYTE for i in range(MOCK_SPI_TEST_DATA_LEN)])
+    self.assertEqual(self.spi.write(DATA_TO_WRITE),
+                     DATA_TO_EXPECT,
+                     "SPI write() returned unexpected data")
+
+if __name__ == "__main__":
+  u.main()

tests/mock/spi_checks_write_byte.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksWriteByte(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_write_byte(self):
+    TEST_BYTE = 0xEE
+    self.assertEqual(self.spi.writeByte(TEST_BYTE),
+                     TEST_BYTE ^ MOCK_SPI_REPLY_DATA_MODIFIER_BYTE,
+                     "SPI writeByte() returned unexpected data")
+
+  def test_spi_write_byte_invalid_bigger_than_max(self):
+    TEST_VALUE = 0xEEFF
+    self.assertRaises(OverflowError, self.spi.writeByte, TEST_VALUE)
+
+  def test_spi_write_byte_invalid_smaller_than_min(self):
+    TEST_VALUE = -1
+    self.assertRaises(OverflowError, self.spi.writeByte, TEST_VALUE)
+
+if __name__ == "__main__":
+  u.main()

tests/mock/spi_checks_write_word.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+
+# Author: Alex Tereschenko <alext.mkrs@gmail.com>
+# Copyright (c) 2016 Alex Tereschenko.
+#
+# 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 mraa as m
+import unittest as u
+
+from spi_checks_shared import *
+
+class SpiChecksWriteWord(u.TestCase):
+  def setUp(self):
+    self.spi = m.Spi(MRAA_SPI_BUS_NUM)
+
+  def tearDown(self):
+    del self.spi
+
+  def test_spi_write_word(self):
+    TEST_WORD = 0xAAEE
+    self.assertEqual(self.spi.writeWord(TEST_WORD),
+                     TEST_WORD ^ MOCK_SPI_REPLY_DATA_MODIFIER_WORD,
+                     "SPI writeWord() returned unexpected data")
+
+  def test_spi_write_word_invalid_bigger_than_max(self):
+    TEST_VALUE = 0xEEFFEE
+    self.assertRaises(OverflowError, self.spi.writeWord, TEST_VALUE)
+
+  def test_spi_write_word_invalid_smaller_than_min(self):
+    TEST_VALUE = -1
+    self.assertRaises(OverflowError, self.spi.writeWord, TEST_VALUE)
+
+if __name__ == "__main__":
+  u.main()