Skip to content

Commit 1f5e523

Browse files
author
Nir Sonnenschein
authored
Merge pull request #7976 from mprse/spi_feature_branch_test_ci
Add SPI basic test and test header file.
2 parents baf9d19 + 9a3e96d commit 1f5e523

File tree

10 files changed

+751
-44
lines changed

10 files changed

+751
-44
lines changed

‎TESTS/mbed_hal/spi/main.cpp

Lines changed: 561 additions & 0 deletions
Large diffs are not rendered by default.

‎TESTS/mbed_hal/spi/spi_api_tests.h

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
/* mbed Microcontroller Library
2+
* Copyright (c) 2018 ARM Limited
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/** \addtogroup hal_spi_tests */
18+
/** @{*/
19+
20+
#ifndef MBED_SPI_API_TESTS_H
21+
#define MBED_SPI_API_TESTS_H
22+
23+
#include "device.h"
24+
25+
#if DEVICE_SPI
26+
27+
#ifdef __cplusplus
28+
extern "C" {
29+
#endif
30+
31+
/** Test that spi_get_module() returns the SPIName - unique identifier to the peripheral associated
32+
* to this SPI channel.
33+
*
34+
* Given is platform with SPI support.
35+
* When spi_get_module() is called with valid SPI pins.
36+
* Then function returns the SPIName - unique identifier to the peripheral associated
37+
* to this SPI channel.
38+
*
39+
* @note `mosi` or `miso` pin can be undefined (but not both). `mclk` must be defined.
40+
*/
41+
void test_get_module();
42+
43+
/** Test that spi_get_capabilities() fills the given spi_capabilities_t instance with capabilities
44+
* of the specified SPI peripheral.
45+
*
46+
* Given is platform with SPI support.
47+
* When spi_get_capabilities() is called with the valid SPI name (and SS pin).
48+
* Then function fills the given spi_capabilities_t instance with capabilities
49+
* of the specified SPI peripheral.
50+
*
51+
* @note spi_get_capabilities() considers the `ssel` pin when evaluation the
52+
* support_slave_mode capability.
53+
*
54+
*/
55+
void test_get_capabilities();
56+
57+
/** Test that spi_init() successfully initializes the pins and spi_free() can successfully
58+
* reset the pins to their default state.
59+
*
60+
* Given is platform with SPI support.
61+
* When spi_init() is called with the valid pins configuration and then spi_free() is called on
62+
* the created SPI object.
63+
* Then both operations are successfully performed.
64+
*
65+
*/
66+
void test_init_free();
67+
68+
/** Test that spi_format() sets/updates the transmission format of the SPI peripheral.
69+
*
70+
* Given is platform with SPI support.
71+
* When spi_format() is called and valid format is specified.
72+
* Then function is executed successfully.
73+
*
74+
*/
75+
void test_set_format();
76+
77+
/** Test that test_set_frequency() sets the frequency used during the SPI transfer.
78+
*
79+
* Given is platform with SPI support.
80+
* When test_set_frequency() is called and valid frequency is specified.
81+
* Then function is executed successfully and actual frequency which will be used during the transfer is returned.
82+
*
83+
* @note Frequency can be only set by SPI peripheral operating in master mode.
84+
* @note Frequency must be in range specified by the capabilities of the SPI peripheral.
85+
*
86+
*/
87+
void test_set_frequency();
88+
89+
/** Test that spi_transfer() can successfully perform transfer in master mode
90+
* (TX/RX buffers are defined and have the same sizes) and returns the number of
91+
* symbols clocked on the bus during this transfer.
92+
*
93+
* Given is platform with SPI support.
94+
* When spi_transfer() is called for SPI peripheral operating in master mode and
95+
* both TX/RX buffers are specified and have equal sizes.
96+
* Then function is executed successfully and returns number of symbols clocked on the bus during this transfer.
97+
*
98+
*/
99+
void test_transfer_master();
100+
101+
/** Test that spi_transfer() can successfully perform transfer in master mode
102+
* (TX/RX buffers are undefined or have different sizes) and returns the number of
103+
* symbols clocked on the bus during this transfer.
104+
*
105+
* Given is platform with SPI support.
106+
* When spi_transfer() is called for SPI peripheral operating in master mode and
107+
* TX/RX buffers are undefined or have different sizes.
108+
* Then function is executed successfully and returns number of symbols clocked on the bus during this transfer.
109+
*
110+
*/
111+
void test_transfer_master_fill_sym();
112+
113+
/** Test that spi_transfer_async() can successfully perform asynchronous transfer
114+
* in master mode.
115+
*
116+
* Given is platform with SPI support.
117+
* When spi_transfer_async() is called for SPI peripheral operating in master mode.
118+
* Then function returns true on success, performs transfer and invokes specified callback
119+
* when the transfer completes (passing the operation status).
120+
*
121+
*/
122+
void test_transfer_master_async();
123+
124+
/** Test that spi_transfer_async_abort() can successfully abort an on-going async transfer.
125+
*
126+
* Given is platform with SPI support.
127+
* When spi_transfer_async() is called for SPI peripheral operating in master mode and
128+
* operation is aborted immediately by means of spi_transfer_async_abort().
129+
* Then operation is successfully performed and specified callback is invoked with
130+
* the status which indicates that the transfer has been aborted.
131+
*
132+
*/
133+
void test_transfer_master_async_abort();
134+
135+
/**@}*/
136+
137+
#ifdef __cplusplus
138+
}
139+
#endif
140+
141+
#endif
142+
143+
#endif
144+
145+
/**@}*/

‎targets/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_K66F/TARGET_FRDM/PeripheralNames.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,14 +124,19 @@ typedef enum {
124124
DAC_0 = 0
125125
} DACName;
126126

127-
128127
#define SPI_COUNT 3
129128
typedef enum {
130129
SPI_0 = 0,
131130
SPI_1 = 1,
132131
SPI_2 = 2,
133132
} SPIName;
134133

134+
/* Specify master/slave interfaces for testing purposes. */
135+
#define SPI_TEST_MASTER SPI_2
136+
#define SPI_TEST_SLAVE SPI_0
137+
#define SPI_TEST_MASTER_PIN(SPI_PIN) SPI_2##_##SPI_PIN
138+
#define SPI_TEST_SLAVE_PIN(SPI_PIN) SPI_0##_##SPI_PIN
139+
135140
#ifdef __cplusplus
136141
}
137142
#endif

‎targets/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_K66F/TARGET_FRDM/PinNames.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,26 @@ typedef enum {
232232

233233
I2C_SCL = D15,
234234
I2C_SDA = D14,
235+
236+
/* Note:
237+
This board does not provide SPI MOSI/MISO pins, instead we have SIN/SOUT pins which can be used
238+
as SPI MOSI/MISO lines depending on SPI operation mode(master or slave):
239+
master: SIN ---> MISO
240+
SOUT ---> MOSI
241+
slave: SIN ---> MOSI
242+
SOUT ---> MISO
243+
244+
SPI_0 interface represents SPI pins configuration for slave and SPI_2 respresents spi configuration
245+
for master.
246+
*/
247+
SPI_0_MOSI = PTD3,
248+
SPI_0_MISO = PTD2,
249+
SPI_0_SCK = PTD1,
250+
SPI_0_CS = PTD0,
251+
SPI_2_MOSI = PTD13,
252+
SPI_2_MISO = PTB23,
253+
SPI_2_SCK = PTD12,
254+
SPI_2_CS = PTB20,
235255

236256
A0 = PTB7,
237257
A1 = PTB6,

‎targets/TARGET_STM/TARGET_STM32F4/TARGET_STM32F429xI/TARGET_NUCLEO_F429ZI/PeripheralNames.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ typedef enum {
6666
SPI_5 = (int)SPI5_BASE,
6767
SPI_6 = (int)SPI6_BASE
6868
} SPIName;
69+
/* Specify master/slave SPI interfaces for testing purposes. */
70+
#define SPI_TEST_MASTER SPI_1
71+
#define SPI_TEST_SLAVE SPI_4
72+
#define SPI_TEST_MASTER_PIN(SPI_PIN) SPI_1##_##SPI_PIN
73+
#define SPI_TEST_SLAVE_PIN(SPI_PIN) SPI_4##_##SPI_PIN
6974

7075
typedef enum {
7176
I2C_1 = (int)I2C1_BASE,

‎targets/TARGET_STM/TARGET_STM32F4/TARGET_STM32F429xI/TARGET_NUCLEO_F429ZI/PinNames.h

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,12 +269,17 @@ typedef enum {
269269
USBRX = STDIO_UART_RX, // Virtual Com Port
270270
I2C_SCL = D15,
271271
I2C_SDA = D14,
272-
SPI_MOSI = D11,
273-
SPI_MISO = D12,
274-
SPI_SCK = D13,
275-
SPI_CS = D10,
276272
PWM_OUT = D9,
277273

274+
SPI_1_MOSI = PB_5,
275+
SPI_1_MISO = PA_6,
276+
SPI_1_SCK = PA_5,
277+
SPI_1_CS = PA_4,
278+
SPI_4_MOSI = PE_6,
279+
SPI_4_MISO = PE_5,
280+
SPI_4_SCK = PE_2,
281+
SPI_4_CS = PE_4,
282+
278283
/**** USB pins ****/
279284
USB_OTG_FS_DM = PA_11,
280285
USB_OTG_FS_DP = PA_12,

‎targets/TARGET_STM/stm_spi_api.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ uint32_t spi_transfer(spi_t *obj, const void *tx_buffer, uint32_t tx_length,
525525
out = *(uint8_t *)write_fill;
526526
}
527527
in = spi_write(obj, out);
528-
if (i < rx_length) {
528+
if (rx_buffer && i < rx_length) {
529529
((uint8_t*)rx_buffer)[i] = (uint8_t)in;
530530
}
531531
break;
@@ -536,7 +536,7 @@ uint32_t spi_transfer(spi_t *obj, const void *tx_buffer, uint32_t tx_length,
536536
out = *(uint16_t *)write_fill;
537537
}
538538
in = spi_write(obj, out);
539-
if (i < rx_length) {
539+
if (rx_buffer && i < rx_length) {
540540
((uint16_t*)rx_buffer)[i] = (uint16_t)in;
541541
}
542542
break;

‎targets/TARGET_TT/TARGET_TT_M3HQ/spi_api.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2828
*******************************************************************************
2929
*/
30+
#if DEVICE_SPI
31+
3032
#include "spi_api.h"
3133
#include "mbed_error.h"
3234
#include "pinmap.h"
@@ -274,3 +276,4 @@ uint8_t spi_get_module(spi_t *obj)
274276
{
275277
return (uint8_t)(obj->module);
276278
}
279+
#endif

‎targets/targets.json

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1299,8 +1299,6 @@
12991299
"PWMOUT",
13001300
"SERIAL",
13011301
"SLEEP",
1302-
"SPI",
1303-
"SPISLAVE",
13041302
"TRNG",
13051303
"STDIO_MESSAGES",
13061304
"FLASH",
@@ -7738,8 +7736,6 @@
77387736
"CAN",
77397737
"I2CSLAVE",
77407738
"ANALOGOUT",
7741-
"SPI",
7742-
"SPISLAVE",
77437739
"SERIAL_ASYNCH",
77447740
"SERIAL_FC",
77457741
"EMAC",
@@ -7772,7 +7768,6 @@
77727768
"PWMOUT",
77737769
"SERIAL",
77747770
"SLEEP",
7775-
"SPI",
77767771
"I2C",
77777772
"I2CSLAVE",
77787773
"STDIO_MESSAGES",
@@ -7793,8 +7788,6 @@
77937788
"CAN",
77947789
"I2CSLAVE",
77957790
"ANALOGOUT",
7796-
"SPI",
7797-
"SPISLAVE",
77987791
"SERIAL_ASYNCH",
77997792
"SERIAL_FC",
78007793
"EMAC",
@@ -7822,8 +7815,6 @@
78227815
"CAN",
78237816
"I2CSLAVE",
78247817
"ANALOGOUT",
7825-
"SPI",
7826-
"SPISLAVE",
78277818
"SERIAL_ASYNCH",
78287819
"SERIAL_FC",
78297820
"FLASH",

‎tools/test/examples/examples.json

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -271,21 +271,6 @@
271271
"export": true,
272272
"auto-update" : true
273273
},
274-
{
275-
"name": "mbed-os-example-bootloader",
276-
"github":"https://github.com/ARMmbed/mbed-os-example-bootloader",
277-
"mbed": [
278-
"https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-bootloader"
279-
],
280-
"test-repo-source": "github",
281-
"features" : [],
282-
"targets" : ["NUCLEO_F429ZI"],
283-
"toolchains" : [],
284-
"exporters": [],
285-
"compile" : true,
286-
"export": true,
287-
"auto-update" : true
288-
},
289274
{
290275
"name": "mbed-os-example-mbed-crypto",
291276
"github":"https://github.com/ARMmbed/mbed-os-example-mbed-crypto",
@@ -352,19 +337,6 @@
352337
"compile" : true,
353338
"export": true,
354339
"auto-update" : true
355-
},
356-
{
357-
"name": "mbed-os-example-sd-driver",
358-
"github":"https://github.com/ARMmbed/mbed-os-example-sd-driver",
359-
"mbed": [],
360-
"test-repo-source": "github",
361-
"features" : [],
362-
"targets" : ["K64F"],
363-
"toolchains" : [],
364-
"exporters": [],
365-
"compile" : true,
366-
"export": true,
367-
"auto-update" : true
368340
}
369341
]
370342
}

0 commit comments

Comments
 (0)