begriffs open source - cmsis-driver-validation/blob

1 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/

2 /**

3 \defgroup usart_config Configuration

4 \ingroup dv_usart

5

6 The USART driver validation settings are available in the DV_USART_Config.h configuration file.

7

8 \image html dv_usart_config_h.png "DV_USART_Config.h configuration file in Configuration Wizard view mode"

9

10 Some settings depend on the test environment and need to be changed for proper operation of the USART driver validation.

11

12 \section usart_config_detail Configuration settings

13

14 Driver_USART# selects the driver instance that will be tested.

15 For example if we want to test <c>Driver_USART2</c> then this setting would be set to <c>2</c>.

16

17 Configuration section contains configuration of: Test Mode, USART Server and Tests settings:

18 - Test Mode can be set to Loopback or USART Server.

19 Loopback mode should be used for initial validation.

20 Loopback mode requires that Tx and Rx pins are connected together thus driver validation can test basic

21 functionality.

22 For full compliance of the USART driver with the CMSIS-Driver USART specification the USART Server Test Mode has to be used.

23 - USART Server settings are relevant if Test Mode: USART Server is selected.

24 These settings specify communication settings at which Driver Validation communicates with the USART Server

25 and must be same as configured on the USART Server.

26 - Some settings are fixed and cannot be changed, these are the following ones:

27 - Baudrate: 115200

28 - Data Bits: 8

29 - Parity: None

30 - Stop Bits: 1

31 - Flow Control: None

32 - Only configurable setting for the USART Server is:

33 - Mode setting specifies the mode for communication with USART Server.

34 Different modes require different physical connection and also USART Server must use same setting.

35 For details on modes please check \ref usart_server_con "USART Server connection".

36 - Tests settings specify tests configuration:

37 - Default settings specifies the default settings used in the data exchange tests.

38 Usually, one feature is tested by executing the data exchange while all other parameters are used as default.

39 For details on which parameters are used as default in each test function please refer to \ref usart_tests_data_xchg

40 functions documentation.

41 - Baudrate settings specifies minimum and maximum bus speeds at which data transfer will be executed.

42 These settings are used by the \ref USART_Baudrate_Min and \ref USART_Baudrate_Max test functions.

43 - Number of Items settings specifies a few different number of items to be tested.

44 These settings are used by the \ref USART_Number_Of_Items test function which tests that odd and unusual number of items

45 are transferred correctly according to the CMSIS-Driver specification.

46

47 Tests section contains selection of tests to be executed:

48 - Driver Management allows enabling or disabling of the whole driver management group of test functions.

49 Each test function in this group can be enabled or disabled individually, for details on tests performed

50 by each test function please refer to \ref usart_tests_drv_mgmt documentation.

51 - Data Exchange allows enabling or disabling of the whole data exchange group of test functions.

52 Each test function in this group can be enabled or disabled individually, for details on tests performed

53 by each test function please refer to \ref usart_tests_data_xchg documentation.

54 - Modem allows enabling or disabling of the whole modem lines group of test functions.

55 Each test function in this group can be enabled or disabled individually, for details on tests performed

56 by each test function please refer to \ref usart_tests_modem documentation.

57 - Event allows enabling or disabling of the whole event group of test functions.

58 Each test function in this group can be enabled or disabled individually, for details on tests performed

59 by each test function please refer to \ref usart_tests_evt documentation.

60 */

61

62

63 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/

64 /**

65 \defgroup usart_server USART Server

66 \ingroup dv_usart

67

68 The USART Server is an application providing a set of features used by the CMSIS-Driver Validation suite to test the

69 physical operation of the USART driver.

70 It is located in the <c>\<pack root directory\></c>\\Tools\\USART_Server directory.

71

72 The USART Server offers the following features:

73 - read of the version information

74 - read of the capabilities information

75 - set and read of the data buffers content

76 - read of the last send/receive/transfer count

77 - send of data

78 - reception of data

79 - transfer in synchronous mode

80 - generation of break signal

81 - read of break signal status

82 - control of modem lines

83 - read of modem lines state

84

85 \section usart_server_oper Operation

86

87 The USART Server is continuously waiting on a command from the USART Client (Driver Validation),

88 after the command is received it is executed, and the process repeats.

89 Most commands do not have any additional related data phase, but some do have additional input or output

90 data exchange phase following the command.

91

92 \section usart_server_config Configuration

93

94 Communication interface settings used during command exchange are set in the USART_Server_Config.h configuration file.

95 \image html usart_server_config_h.png "USART_Server_Config.h configuration file in Configuration Wizard view mode"

96

97 \subsection usart_server_config_detail Configuration settings

98

99 Driver_USART# selects the driver instance used by the USART Server.

100 Communication settings specify the communication parameters for command exchange with the USART Client:

101 - Mode setting specifies the mode used for command exchange.

102 Different modes require different physical connection and also USART Server must use same setting.

103 For details on modes please check \ref usart_server_con "USART Server connection".

104

105 Fixed communication settings used for command exchange with the USART Client are:

106 - Baudrate: 115200

107 - Data Bits: 8

108 - Parity: None

109 - Stop Bits: 1

110 - Flow Control: None

111

112 \section usart_server_commands Commands

113

114 Commands are encoded in human readable format (ASCII strings) so they can be viewed by the USART bus analyzer

115 and analyzed more easily.

116

117 Supported commands:

118 - GET VER: used to retrieve the version of the USART Server application

119 - GET CAP: used to retrieve the capabilities of the USART Server

120 (the Server auto-detects capabilities upon reception of this command)

121 - SET BUF: used for initialization of the content of receive or transmit buffer of the USART Server

122 - GET BUF: used for retrieving the content of receive or transmit buffer of the USART Server

123 - SET COM: used for specifying configuration of the send/receive/transfer activated by the XFER command

124 - XFER: used to trigger a send/receive/transfer (parameters specified with the last SET COM command)

125 - GET CNT: used to retrieve the number of sent/received/transferred items in previous send/receive/transfer

126 - SET BRK: used to instruct USART Server to generate break signal

127 - GET BRK: used to retrieve break signal status on the USART Server

128 - SET MDM: used for activation of modem lines

129 - GET MDM: used to retrieve modem lines status on the USART Server

130

131 \note For details about commands please refer to Abstract.txt file in the

132 <c>\<pack root directory\></c>\\Tools\\USART_Server\\Board\\MCBSTM32F400 directory.

133

134 Picture below shows a capture of USART Driver Validation validating functionality of the Send function in the Asynchronous mode

135 \image html usart_bus_async_send.png

136

137 \section usart_server_porting Porting USART Server to other targets

138

139 To create USART Server application for a different target device, follow the steps below:

140 -# Create a new project in µVision for your target device

141 -# In the RTE window enable and configure the following software components:

142 - CMSIS: CORE

143 - CMSIS: RTOS2 (API): Keil RTX5 any variant

144 - CMSIS Driver: USART (API)

145 - CMSIS Driver: VIO (API) select Virtual implementation if implementation for your target system is not available

146 - Generic device specific components (startup, clock system, I/O, ...) as required

147 (please consult device's documentation for more information)

148 - Resolve any unresolved dependencies between components

149 -# Copy the USART_Server.c file from the <c>\<pack root directory\></c>\\Tools\\USART_Server\\Source directory

150 to the project root and add it to µVision project

151 -# Copy the USART_Server.h file from the <c>\<pack root directory\></c>\\Tools\\USART_Server\\Include

152 directory to the project root

153 -# Copy the files specified below from the directory <c>\<pack root directory\></c>\\Tools\\USART_Server\\Config to the project root:

154 - USART_Server_Config.h: also adapt this file as required by your device

155 - USART_Server_HW.c: add this file to the µVision project also adapt it for your device's specific handling of the GPIO lines for

156 testing of the DCD and RI lines

157 -# Add root of the project to include path (Options for Target -> C/C++ -> Include Paths: .\\)

158 -# Add the main.c file from a template

159 (Right-click Source Group 1... and select Add New Item to Group, select User Code Template and choose the

160 CMSIS-RTOS2 'main' function file from CMSIS: RTOS2:Keil RTX5)

161 and update with code snippet below (replace <c>app_main</c> function):

162 \code

163 #include "USART_Server.h"

164

165 /*----------------------------------------------------------------------------

166 * Application main thread

167 *---------------------------------------------------------------------------*/

168 __NO_RETURN static void app_main (void *argument) {

169 (void)argument;

170 USART_Server_Start();

171 for (;;) {}

172 }

173 \endcode

174 -# Build and download the ported USART Server application to the target device

175

176 \section usart_server_troubleshooting Troubleshooting

177

178 Problems and solutions:

179 1. USART Server is not responding to commands

180 - reset the USART Server

181 - check that correct driver instance is selected in the USART_Server_Config.h file

182 - check that communication settings (mode) between USART Server and USART Driver Validation are the same,

183 if they are not, correct them, rebuild the application and download to the hardware

184 2. USART Server is not responding to commands it reports "Server Start failed!" message

185 if debug variant is used

186 - check heap settings

187 (it has to be larger than 2 * USART_SERVER_BUF_SIZE specified in the USART_Server_Config.h file)

188 - check that RTOS allows allocation of at least 512 bytes for the USART Server main thread

189 (Global Dynamic Memory size [bytes] setting in RTX_Config.h file if RTX5 is used)

190 - check that USART driver used for USART Server supports selected mode and all fixed settings:

191 - Baudrate: 115200

192 - Data Bits: 8

193 - Parity: None

194 - Stop Bits: 1

195 - Flow Control: None

196

197 \section usart_server_MCBSTM32F400 USART Server on the Keil MCBSTM32F400

198

199 µVision project and source files for the MCBSTM32F400 board are available in the <c>\<pack root directory\></c>\\Tools\\USART_Server\\Board\\MCBSTM32F400 directory.

200

201 On the Keil MCBSTM32F400 the USART1 interface is used, with the following pinout:

202

203 | USART function | Pin |

204 | :------------- | :----: |

205 | Tx | PB6 |

206 | Rx | PB7 |

207 | CLK (synchro) | PA8 |

208 | CTS | PA11 |

209 | RTS | PA12 |

210 | DCD test pin | PA9 |

211 | RI test pin | PA10 |

212

213 \note IMPORTANT: Ground must be connected between USART Server and Device (Driver) Under Test

214 so that USART signals have same ground potential.

215

216 For more information please consult Abstract.txt file in the project root.

217

218 \note For synchronous mode testing this device's hardware supports only synchronous Master mode,

219 so it can only be used for testing synchronous Slave mode of the Driver Under Test.

220

221

222 \section usart_server_STM32F429I_DISC1 USART Server on the STMicroelectronics STM32F429I-DISC1 (32F429IDISCOVERY) board

223

224 µVision project and source files for the STM32F429I-DISC1 board are available in the <c>\<pack root directory\></c>\\Tools\\USART_Server\\Board\\STM32F429I-DISC1 directory.

225

226 On the STMicroelectronics STM32F429I-DISC1 board the USART1 interface is used, with the following pinout:

227

228 | USART function | Pin |

229 | :------------- | :----: |

230 | Tx | PA9 |

231 | Rx | PA10 |

232 | CLK (synchro) | PA8 |

233 | CTS | PA11 |

234 | RTS | PA12 |

235 | DCD test pin | PA13 |

236 | RI test pin | PA14 |

237

238 \note IMPORTANT: Ground must be connected between USART Server and Device (Driver) Under Test

239 so that USART signals have same ground potential.

240

241 For more information please consult Abstract.txt file in the project root.

242

243 \note For synchronous mode testing this device's hardware supports only synchronous Master mode,

244 so it can only be used for testing synchronous Slave mode of the Driver Under Test.

245

246 */