Skip to content

Commit bf6f2c3

Browse files
0xc01700xc0170
authored
Merge pull request #8644 from ARMmbed/release-candidate
Release candidate for mbed-os-5.10.3
2 parents e1bea44 + 04790ce commit bf6f2c3

File tree

372 files changed

+108479
-2044
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

372 files changed

+108479
-2044
lines changed

‎.github/issue_template.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
<!--
2+
3+
************************************** WARNING **************************************
4+
5+
The ciarcom bot parses this header automatically. Any deviation from the
6+
template may cause the bot to automatically correct this header or may result in a
7+
warning message, requesting updates.
8+
9+
Please ensure that nothing follows the Issue request type section, all
10+
issue details are within the Description section and no changes are made to the
11+
template format (as detailed below).
12+
13+
*************************************************************************************
14+
15+
-->
16+
117
### Description
218

319
<!--

‎.travis.yml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,25 @@ matrix:
5151
# Print versions we use
5252
- doxygen --version
5353
before_script:
54+
# Build doxygen
55+
- >
56+
(git clone --depth=1 --single-branch --branch Release_1_8_14 https://github.com/doxygen/doxygen;
57+
cd doxygen;
58+
mkdir build;
59+
cd build;
60+
cmake -G "Unix Makefiles" ..;
61+
make;
62+
sudo make install)
5463
# Create BUILD directory for tests
5564
- mkdir BUILD
5665
script:
5766
# Assert that the Doxygen build produced no warnings.
5867
# The strange command below asserts that the Doxygen command had an
5968
# output of zero length
60-
- >
61-
doxygen doxyfile_options 2>&1 |
62-
tee BUILD/doxygen.out && [ ! -s BUILD/doxygen.out ]
69+
- doxygen doxyfile_options 2>&1
70+
# Once Mbed OS has been fixed, enable the full test by replacing the top line with this:
71+
# - ( ! doxygen doxyfile_options 2>&1 | grep . )
72+
6373
# Assert that all binary libraries are named correctly
6474
# The strange command below asserts that there are exactly 0 libraries
6575
# that do not start with lib

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,5 @@
1-
# Description
2-
This document is cheat sheet for everyone who wants to contribute to [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) GitHub repository at GitHub.
3-
All changes in code base should originate from GitHub Issues and take advantage of existing GitHub flows. Goal is to attract contributors and allow them contribute to code and documentation at the same time.
1+
# Contributing to Mbed OS
42

5-
Guidelines from this document are created to help new and existing contributors understand process workflow and align to project rules before pull request is submitted. It explains how a participant should do things like format code, test fixes, and submit patches.
3+
Mbed OS is an open-source, device software platform for the Internet of Things. Contributions are an important part of the platform, and our goal is to make it as simple as possible to become a contributor.
64

7-
## Where to get more information?
8-
You can read more on our [documentation page](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/cont/contributing/).
9-
10-
# How to contribute
11-
We really appreciate your contributions! We are Open Source project and we need your help. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
12-
13-
Before a pull request will be merged, the [mbed Contributor Agreement](http://developer.mbed.org/contributor_agreement/) must be signed.
14-
15-
You can pick up existing [mbed-os GitHub Issue](https://github.com/ARMmbed/mbed-os/issues) and solve it or implement new feature you find important, attractive or just necessary. We will review your proposal via pull request mechanism, give you comments and merge your changes if we decide your contribution satisfy criteria such as quality.
16-
17-
# Enhancements vs Bugs
18-
Enhancements are:
19-
* New features implementation.
20-
* Code refactoring.
21-
* Coding rules, coding styles improvements.
22-
* Code comments improvement.
23-
* Documentation work.
24-
25-
Bugs are:
26-
* Issues rose internally or externally by [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) users.
27-
* Internally (within mbed team) created issues from Continuous Integration pipeline and build servers.
28-
* Issues detected using automation tools such as compilers, sanitizers, static code analysis tools etc.
29-
30-
# Gate Keeper role
31-
Gate Keeper is a person responsible for GitHub process workflow execution and is responsible for repository / project code base. Gate Keeper is also responsible for code (pull request) quality stamp and approves or rejects code changes in project’s code base.
32-
33-
Gate Keepers will review your pull request code, give you comments in pull request comment section and in the end if everything goes well merge your pull request to one of our branches (most probably default ```master``` branch).
34-
35-
Please be patient, digest Gate Keeper's feedback and respond promptly :)
36-
37-
# mbed SDK porting
38-
* For more information regarding mbed SDK porting please refer to [mbed SDK porting](http://developer.mbed.org/handbook/mbed-SDK-porting) handbook.
39-
* Before starting the mbed SDK porting, you might want to familiarize with the [mbed SDK library internals](http://developer.mbed.org/handbook/mbed-library-internals) first.
40-
41-
# Glossary
42-
* Gate Keeper – persons responsible for overall code-base quality of [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os) project.
43-
* Enhancement – New feature deployment, code refactoring actions or existing code improvements.
44-
* Bugfix – Issues originated from GitHub Issues pool, raised internally within mbed classic team or issues from automated code validators like linters, static code analysis tools etc.
45-
* Mbed classic – mbed SDK 2.0 located in GitHub at [ARMmbed/mbed-os](https://github.com/ARMmbed/mbed-os).
5+
To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for contributing to Mbed OS. Please see: [contributing guidelines](https://os.mbed.com/docs/latest/reference/contributing.html).

‎TESTS/mbed_hal/critical_section/critical_section_test.h‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@
1414
* limitations under the License.
1515
*/
1616

17-
/** \addtogroup hal_critical_tests
17+
/** \addtogroup hal_critical
1818
* @{
19+
* \defgroup hal_critical_test Tests
20+
* Tests definitions of the HAL Critical module.
21+
* @{
1922
*/
2023

2124
#ifndef MBED_CRITICAL_SECTION_TEST_H
@@ -45,7 +48,7 @@
4548
template <int N>
4649
void test_critical_section();
4750

48-
51+
/**@}*/
4952
/**@}*/
5053

5154
#endif // MBED_CRITICAL_SECTION_TEST_H

‎TESTS/mbed_hal/qspi/flash_configs/Freescale/K82F/flash_config.h‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
/* mbed Microcontroller Library
2+
* Copyright (c) 2018-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+
#ifndef MBED_QSPI_FLASH_CONFIG_H
17+
#define MBED_QSPI_FLASH_CONFIG_H
18+
19+
#include "../../MX25RXX35F_config.h"
20+
21+
/* Fast mode not supported in MX25U3235F */
22+
#undef FAST_MODE_ENABLE
23+
#undef FAST_MODE_DISABLE
24+
25+
#ifdef QSPI_SECTOR_COUNT
26+
#undef QSPI_SECTOR_COUNT
27+
#define QSPI_SECTOR_COUNT 1024 // for MX25U3235F
28+
#endif
29+
30+
/* The values for MX25U3235F are different, specify this here */
31+
#undef QSPI_COMMON_MAX_FREQUENCY
32+
#undef QSPI_WRSR_MAX_TIME
33+
#undef QSPI_PAGE_PROG_MAX_TIME
34+
#undef QSPI_ERASE_SECTOR_MAX_TIME
35+
#undef QSPI_ERASE_BLOCK_32_MAX_TIME
36+
#undef QSPI_ERASE_BLOCK_64_MAX_TIME
37+
38+
/* Implementation of these macros are slightly different for MX25U3235F */
39+
#undef EXTENDED_SPI_ENABLE
40+
#undef EXTENDED_SPI_DISABLE
41+
42+
/* Max frequency for basic rw operation in MX25U3235F */
43+
#define QSPI_COMMON_MAX_FREQUENCY 54000000
44+
45+
/* WRSR operations max time [us] (datasheet max time + 15%) */
46+
#define QSPI_WRSR_MAX_TIME 46000 // 40ms
47+
48+
/* Write operations max time [us] (datasheet max time + 15%) */
49+
#define QSPI_PAGE_PROG_MAX_TIME 3450 // 3ms
50+
51+
/* erase operations max time [us] (datasheet max time + 15%) */
52+
#define QSPI_ERASE_SECTOR_MAX_TIME 230000 // 200 ms
53+
#define QSPI_ERASE_BLOCK_32_MAX_TIME 1150000 // 1s
54+
#define QSPI_ERASE_BLOCK_64_MAX_TIME 2300000 // 2s
55+
56+
#define EXTENDED_SPI_ENABLE() \
57+
\
58+
const int32_t reg_size = QSPI_STATUS_REG_SIZE; \
59+
uint8_t reg_data[reg_size] = { 0 }; \
60+
\
61+
if (read_register(STATUS_REG, reg_data, \
62+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
63+
return QSPI_STATUS_ERROR; \
64+
} \
65+
if (write_enable(qspi) != QSPI_STATUS_OK) { \
66+
return QSPI_STATUS_ERROR; \
67+
} \
68+
\
69+
reg_data[0] = STATUS_BIT_QE; \
70+
if (write_register(QSPI_CMD_WRSR, reg_data, \
71+
reg_size, qspi) != QSPI_STATUS_OK) { \
72+
return QSPI_STATUS_ERROR; \
73+
} \
74+
WAIT_FOR(WRSR_MAX_TIME, qspi); \
75+
\
76+
memset(reg_data, 0, QSPI_STATUS_REG_SIZE); \
77+
if (read_register(STATUS_REG, reg_data, \
78+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
79+
return QSPI_STATUS_ERROR; \
80+
} \
81+
\
82+
return ((reg_data[0] & STATUS_BIT_QE) != 0 ? \
83+
QSPI_STATUS_OK : QSPI_STATUS_ERROR)
84+
85+
86+
87+
#define EXTENDED_SPI_DISABLE() \
88+
\
89+
const int32_t reg_size = QSPI_STATUS_REG_SIZE; \
90+
uint8_t reg_data[reg_size] = { 0 }; \
91+
\
92+
if (read_register(STATUS_REG, reg_data, \
93+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
94+
return QSPI_STATUS_ERROR; \
95+
} \
96+
\
97+
if (write_enable(qspi) != QSPI_STATUS_OK) { \
98+
return QSPI_STATUS_ERROR; \
99+
} \
100+
\
101+
reg_data[0] &= ~(STATUS_BIT_QE); \
102+
\
103+
if (write_register(QSPI_CMD_WRSR, reg_data, \
104+
reg_size, qspi) != QSPI_STATUS_OK) { \
105+
return QSPI_STATUS_ERROR; \
106+
} \
107+
WAIT_FOR(WRSR_MAX_TIME, qspi); \
108+
\
109+
reg_data[0] = 0; \
110+
if (read_register(STATUS_REG, reg_data, \
111+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
112+
return QSPI_STATUS_ERROR; \
113+
} \
114+
\
115+
return ((reg_data[0] & STATUS_BIT_QE) == 0 ? \
116+
QSPI_STATUS_OK : QSPI_STATUS_ERROR)
117+
118+
#endif // MBED_QSPI_FLASH_CONFIG_H

‎TESTS/mbed_hal/qspi/flash_configs/Freescale/KL82Z/flash_config.h‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
/* mbed Microcontroller Library
2+
* Copyright (c) 2018-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+
#ifndef MBED_QSPI_FLASH_CONFIG_H
17+
#define MBED_QSPI_FLASH_CONFIG_H
18+
19+
#include "../../MX25RXX35F_config.h"
20+
21+
/* Fast mode not supported in MX25L12845G */
22+
#undef FAST_MODE_ENABLE
23+
#undef FAST_MODE_DISABLE
24+
25+
#ifdef QSPI_SECTOR_COUNT
26+
#undef QSPI_SECTOR_COUNT
27+
#define QSPI_SECTOR_COUNT 4096 // for MX25L12845G
28+
#endif
29+
30+
/* The values for MX25U3235F are different, specify this here */
31+
#undef QSPI_COMMON_MAX_FREQUENCY
32+
#undef QSPI_WRSR_MAX_TIME
33+
#undef QSPI_PAGE_PROG_MAX_TIME
34+
#undef QSPI_ERASE_SECTOR_MAX_TIME
35+
#undef QSPI_ERASE_BLOCK_32_MAX_TIME
36+
#undef QSPI_ERASE_BLOCK_64_MAX_TIME
37+
38+
/* Implementation of these macros are slightly different for MX25L12845G */
39+
#undef EXTENDED_SPI_ENABLE
40+
#undef EXTENDED_SPI_DISABLE
41+
42+
/* Max frequency for basic rw operation based on max bus frequency of 24MHz */
43+
#define QSPI_COMMON_MAX_FREQUENCY 23000000
44+
45+
/* WRSR operations max time [us] (datasheet max time + 15%) */
46+
#define QSPI_WRSR_MAX_TIME 46000 // 40ms
47+
48+
/* Write operations max time [us] (datasheet max time + 15%) */
49+
#define QSPI_PAGE_PROG_MAX_TIME 1000 // 0.75ms
50+
51+
/* erase operations max time [us] (datasheet max time + 15%) */
52+
#define QSPI_ERASE_SECTOR_MAX_TIME 460000 // 400 ms
53+
#define QSPI_ERASE_BLOCK_32_MAX_TIME 1150000 // 1s
54+
#define QSPI_ERASE_BLOCK_64_MAX_TIME 2300000 // 2s
55+
56+
#define EXTENDED_SPI_ENABLE() \
57+
\
58+
const int32_t reg_size = QSPI_STATUS_REG_SIZE; \
59+
uint8_t reg_data[reg_size] = { 0 }; \
60+
\
61+
if (read_register(STATUS_REG, reg_data, \
62+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
63+
return QSPI_STATUS_ERROR; \
64+
} \
65+
if (write_enable(qspi) != QSPI_STATUS_OK) { \
66+
return QSPI_STATUS_ERROR; \
67+
} \
68+
\
69+
reg_data[0] = STATUS_BIT_QE; \
70+
if (write_register(QSPI_CMD_WRSR, reg_data, \
71+
reg_size, qspi) != QSPI_STATUS_OK) { \
72+
return QSPI_STATUS_ERROR; \
73+
} \
74+
WAIT_FOR(WRSR_MAX_TIME, qspi); \
75+
\
76+
memset(reg_data, 0, QSPI_STATUS_REG_SIZE); \
77+
if (read_register(STATUS_REG, reg_data, \
78+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
79+
return QSPI_STATUS_ERROR; \
80+
} \
81+
\
82+
return ((reg_data[0] & STATUS_BIT_QE) != 0 ? \
83+
QSPI_STATUS_OK : QSPI_STATUS_ERROR)
84+
85+
86+
87+
#define EXTENDED_SPI_DISABLE() \
88+
\
89+
const int32_t reg_size = QSPI_STATUS_REG_SIZE; \
90+
uint8_t reg_data[reg_size] = { 0 }; \
91+
\
92+
if (read_register(STATUS_REG, reg_data, \
93+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
94+
return QSPI_STATUS_ERROR; \
95+
} \
96+
\
97+
if (write_enable(qspi) != QSPI_STATUS_OK) { \
98+
return QSPI_STATUS_ERROR; \
99+
} \
100+
\
101+
reg_data[0] &= ~(STATUS_BIT_QE); \
102+
\
103+
if (write_register(QSPI_CMD_WRSR, reg_data, \
104+
reg_size, qspi) != QSPI_STATUS_OK) { \
105+
return QSPI_STATUS_ERROR; \
106+
} \
107+
WAIT_FOR(WRSR_MAX_TIME, qspi); \
108+
\
109+
reg_data[0] = 0; \
110+
if (read_register(STATUS_REG, reg_data, \
111+
QSPI_STATUS_REG_SIZE, qspi) != QSPI_STATUS_OK) { \
112+
return QSPI_STATUS_ERROR; \
113+
} \
114+
\
115+
return ((reg_data[0] & STATUS_BIT_QE) == 0 ? \
116+
QSPI_STATUS_OK : QSPI_STATUS_ERROR)
117+
118+
#endif // MBED_QSPI_FLASH_CONFIG_H

‎TESTS/mbed_hal/qspi/flash_configs/flash_configs.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
#include "STM/DISCO_F413ZH/flash_config.h"
2626
#elif defined(TARGET_EFM32GG11_STK3701)
2727
#include "SiliconLabs/EFM32GG11_STK3701/flash_config.h"
28+
#elif defined(TARGET_K82F)
29+
#include "Freescale/K82F/flash_config.h"
30+
#elif defined(TARGET_KL82Z)
31+
#include "Freescale/KL82Z/flash_config.h"
2832
#endif
2933

3034
#endif // MBED_FLASH_CONFIGS_H

‎TESTS/mbed_hal/qspi/qspi_test.h‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@
1414
* limitations under the License.
1515
*/
1616

17-
/** \addtogroup hal_qspi_tests
17+
/** \addtogroup hal_qspi
1818
* @{
19+
* \defgroup hal_qspi_tests Tests
20+
* QSPI tests of the HAL.
21+
* @{
1922
*/
2023
#ifndef MBED_QSPI_TEST_H
2124
#define MBED_QSPI_TEST_H
@@ -96,3 +99,4 @@ void qspi_write_read_test(void);
9699
#endif
97100

98101
/** @}*/
102+
/** @}*/

0 commit comments

Comments
 (0)