Add header files for fpga spi tests and map test cases to defined behavior.

Also, update names of the test functions (basic test and fpga tests) so they are more consistent and unique.

Author: mprse

TESTS/mbed_hal/spi/main.cpp

@@ -176,7 +176,7 @@ static void async_handler(spi_t *obj, void *ctx, spi_async_event_t *event)
 
 /* Test that spi_get_module() returns the SPIName - unique identifier to the peripheral associated
  * to this SPI channel. */
-void test_get_module()
+void spi_test_get_module()
 {
     SPIName spi_name;
 
@@ -193,7 +193,7 @@ void test_get_module()
 
 /* Test that spi_get_capabilities() fills the given spi_capabilities_t instance with capabilities
  * of the specified SPI peripheral. */
-void test_get_capabilities()
+void spi_test_get_capabilities()
 {
     spi_capabilities_t capabilities;
 
@@ -229,7 +229,7 @@ void test_get_capabilities()
 
 /* Test that spi_init() successfully initializes the pins and spi_free() can successfully
  * reset the pins to their default state. */
-void test_init_free()
+void spi_test_init_free()
 {
     spi_t spi_obj = { 0 };
     spi_capabilities_t capabilities = { 0 };
@@ -295,7 +295,7 @@ void test_init_free()
 }
 
 /* Test that spi_format() sets/updates the transmission format of the SPI peripheral. */
-void test_set_format()
+void spi_test_set_format()
 {
     spi_t spi_obj = { 0 };
     spi_capabilities_t capabilities = { 0 };
@@ -343,8 +343,8 @@ void test_set_format()
     TEST_ASSERT_TRUE(true);
 }
 
-/* Test that test_set_frequency() sets the frequency used during the SPI transfer. */
-void test_set_frequency()
+/* Test that spi_test_set_frequency() sets the frequency used during the SPI transfer. */
+void spi_test_set_frequency()
 {
     spi_t spi_obj = { 0 };
     uint32_t real_freq;
@@ -372,7 +372,7 @@ void test_set_frequency()
 /* Test that spi_transfer() can successfully perform transfer in master mode
  *  (TX/RX buffers are defined and have the same sizes) and returns the number of
  *  symbols clocked on the bus during this transfer. */
-void test_transfer_master()
+void spi_test_transfer_master()
 {
     spi_t spi_obj = { 0 };
     spi_capabilities_t capabilities = { 0 };
@@ -420,7 +420,7 @@ void test_transfer_master()
 /* Test that spi_transfer() can successfully perform transfer in master mode
  * (TX/RX buffers are undefined or have different sizes) and returns the number of
  * symbols clocked on the bus during this transfer. */
-void test_transfer_master_fill_sym()
+void spi_test_transfer_master_fill_sym()
 {
     spi_t spi_obj = { 0 };
     spi_capabilities_t capabilities = { 0 };
@@ -457,7 +457,7 @@ void test_transfer_master_fill_sym()
 #ifdef DEVICE_SPI_ASYNCH
 /* Test that spi_transfer_async() can successfully perform asynchronous transfer
  * in master mode. */
-void test_transfer_master_async()
+void spi_test_transfer_master_async()
 {
     spi_t spi_obj = {0};
     spi_capabilities_t capabilities = {0};
@@ -521,7 +521,7 @@ void test_transfer_master_async()
 }
 
 /* Test that spi_transfer_async_abort() can successfully abort an on-going async transfer. */
-void test_transfer_master_async_abort()
+void spi_test_transfer_master_async_abort()
 {
     spi_t spi_obj = {0};
     spi_capabilities_t capabilities = {0};
@@ -615,16 +615,16 @@ utest::v1::status_t greentea_failure_handler_abort(const Case *const source, con
 }
 
 Case cases[] = {
-    Case("SPI - get module name test", test_get_module, greentea_failure_handler),
-    Case("SPI - get capabilities test", test_get_capabilities, greentea_failure_handler),
-    Case("SPI - init, free test", test_init_free, greentea_failure_handler),
-    Case("SPI - set format test", test_set_format, greentea_failure_handler),
-    Case("SPI - set frequency test", test_set_frequency, greentea_failure_handler),
-    Case("SPI - master transfer test", test_transfer_master, greentea_failure_handler),
-    Case("SPI - fill symbol test", test_transfer_master_fill_sym, greentea_failure_handler),
+    Case("SPI - get module name test", spi_test_get_module, greentea_failure_handler),
+    Case("SPI - get capabilities test", spi_test_get_capabilities, greentea_failure_handler),
+    Case("SPI - init, free test", spi_test_init_free, greentea_failure_handler),
+    Case("SPI - set format test", spi_test_set_format, greentea_failure_handler),
+    Case("SPI - set frequency test", spi_test_set_frequency, greentea_failure_handler),
+    Case("SPI - master transfer test", spi_test_transfer_master, greentea_failure_handler),
+    Case("SPI - fill symbol test", spi_test_transfer_master_fill_sym, greentea_failure_handler),
 #ifdef DEVICE_SPI_ASYNCH
-    Case("SPI - master transfer async test", test_transfer_master_async, greentea_failure_handler),
-    Case("SPI - master transfer async abort test", test_transfer_master_async_abort, greentea_failure_handler),
+    Case("SPI - master transfer async test", spi_test_transfer_master_async, greentea_failure_handler),
+    Case("SPI - master transfer async abort test", spi_test_transfer_master_async_abort, greentea_failure_handler),
 #endif
 };
 

TESTS/mbed_hal/spi/spi_api_tests.h

@@ -38,7 +38,7 @@ extern "C" {
  *
  *  @note `mosi` or `miso` pin can be undefined (but not both). `mclk` must be defined.
  */
-void test_get_module();
+void spi_test_get_module();
 
 /** Test that spi_get_capabilities() fills the given spi_capabilities_t instance with capabilities
  *  of the specified SPI peripheral.
@@ -52,7 +52,7 @@ void test_get_module();
  *        support_slave_mode capability.
  *
  */
-void test_get_capabilities();
+void spi_test_get_capabilities();
 
 /** Test that spi_init() successfully initializes the pins and spi_free() can successfully
  *  reset the pins to their default state.
@@ -63,7 +63,7 @@ void test_get_capabilities();
  *  Then both operations are successfully performed.
  *
  */
-void test_init_free();
+void spi_test_init_free();
 
 /** Test that spi_format() sets/updates the transmission format of the SPI peripheral.
  *
@@ -72,19 +72,19 @@ void test_init_free();
  *  Then function is executed successfully.
  *
  */
-void test_set_format();
+void spi_test_set_format();
 
-/** Test that test_set_frequency() sets the frequency used during the SPI transfer.
+/** Test that spi_test_set_frequency() sets the frequency used during the SPI transfer.
  *
  *  Given is platform with SPI support.
- *  When test_set_frequency() is called and valid frequency is specified.
+ *  When spi_test_set_frequency() is called and valid frequency is specified.
  *  Then function is executed successfully and actual frequency which will be used during the transfer is returned.
  *
  *  @note Frequency can be only set by SPI peripheral operating in master mode.
  *  @note Frequency must be in range specified by the capabilities of the SPI peripheral.
  *
  */
-void test_set_frequency();
+void spi_test_set_frequency();
 
 /** Test that spi_transfer() can successfully perform transfer in master mode
  *  (TX/RX buffers are defined and have the same sizes) and returns the number of
@@ -96,7 +96,7 @@ void test_set_frequency();
  *  Then function is executed successfully and returns number of symbols clocked on the bus during this transfer.
  *
  */
-void test_transfer_master();
+void spi_test_transfer_master();
 
 /** Test that spi_transfer() can successfully perform transfer in master mode
  *  (TX/RX buffers are undefined or have different sizes) and returns the number of
@@ -108,7 +108,7 @@ void test_transfer_master();
  *  Then function is executed successfully and returns number of symbols clocked on the bus during this transfer.
  *
  */
-void test_transfer_master_fill_sym();
+void spi_test_transfer_master_fill_sym();
 
 /** Test that spi_transfer_async() can successfully perform asynchronous transfer
  *  in master mode.
@@ -119,7 +119,7 @@ void test_transfer_master_fill_sym();
  *       when the transfer completes (passing the operation status).
  *
  */
-void test_transfer_master_async();
+void spi_test_transfer_master_async();
 
 /** Test that spi_transfer_async_abort() can successfully abort an on-going async transfer.
  *
@@ -130,7 +130,7 @@ void test_transfer_master_async();
  *       the status which indicates that the transfer has been aborted.
  *
  */
-void test_transfer_master_async_abort();
+void spi_test_transfer_master_async_abort();
 
 /**@}*/
 

TESTS/mbed_hal_fpga_ci_test_shield/spi_master/fpga_spi_master_test.h

@@ -0,0 +1,82 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2019 ARM Limited
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** \addtogroup hal_spi_tests */
+/** @{*/
+
+#ifndef MBED_FPGA_MASTER_SPI_TEST_H
+#define MBED_FPGA_MASTER_SPI_TEST_H
+
+#if DEVICE_SPI
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Test that the spi-Master can be initialized/de-initialized using all possible
+ *  SPI pins.
+ *
+ * Given board provides SPI-Master support.
+ * When SPI-Master is initialized (and then de-initialized) using valid set of SPI pins.
+ * Then the operation is successfull.
+ *
+ */
+void fpga_spi_master_test_init_free(PinName mosi, PinName miso, PinName sclk);
+
+/** Test that the spi_get_capabilities() indicates that slave mode is unsupported if the given `ssel`
+ * pin cannot be managed by hardware.
+ *
+ * Given board provides SPI support.
+ * When `ssel` pin passed to spi_get_capabilities() cannot be managed by hardware.
+ * Then capabilities should indicate that slave mode is unsupported.
+ *
+ */
+void fpga_spi_test_capabilities_ssel(PinName mosi, PinName miso, PinName sclk);
+
+/** Test that the spi_frequency() returns actual SPI frequency.
+ *
+ * Given board provides SPI-Master support.
+ * When specified frequency is selected by means of spi_frequency().
+ * Then frequency returned by spi_frequency() is used for the transmission.
+ *
+ * Additionally we check that spi_format() updates the configuration of the peripheral (format)
+ * except the baud rate generator.
+ */
+void fpga_spi_master_test_freq(PinName mosi, PinName miso, PinName sclk);
+
+/** Test that the SPI-Master transfer can be performed in various configurations.
+ *
+ * Given board provides SPI-Master support.
+ * When SPI transmission is performed using different settings.
+ * Then data is successfully transfered.
+ *
+ * Additionally we check that spi_frequency() updates the baud rate generator
+ * leaving other configurations (format) unchanged.
+ */
+void fpga_spi_master_test_common(PinName mosi, PinName miso, PinName sclk);
+
+/**@}*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
+#endif
+
+/**@}*/