Skip to content

Commit b9ba4e1

Browse files
MM release for STM32MP2 Cube FW
0 parents  commit b9ba4e1

7,942 files changed

Lines changed: 3132010 additions & 0 deletions

File tree

Some content is hidden

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

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team via this [link](https://www.st.com/content/st_com/en/contact-us.html).
59+
All complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
72+
73+
For answers to common questions about this code of conduct, refer to the FAQ section [here](https://www.contributor-covenant.org/faq).

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing guide
2+
3+
This document serves as a checklist before contributing to this repository. It includes links to read up on if topics are unclear to you.
4+
5+
This guide mainly focuses on the proper use of Git.
6+
7+
## 1. Issues
8+
9+
STM32MPU projects do not activate "Github issues" feature for the time being. If you need to report an issue or question about this project deliverables, you can report them using [ ST Support Center ](https://my.st.com/ols#/ols/newrequest) or [ ST Community MPU Forum ](https://community.st.com/s/topic/0TO0X0000003u2AWAQ/stm32-mpus).
10+
11+
## 2. Pull Requests
12+
13+
STMicrolectronics is happy to receive contributions from the community, based on an initial Contributor License Agreement (CLA) procedure.
14+
15+
* If you are an individual writing original source code and you are sure **you own the intellectual property**, then you need to sign an Individual CLA (https://cla.st.com).
16+
* If you work for a company that wants also to allow you to contribute with your work, your company needs to provide a Corporate CLA (https://cla.st.com) mentioning your GitHub account name.
17+
* If you are not sure that a CLA (Individual or Corporate) has been signed for your GitHub account you can check here (https://cla.st.com).
18+
19+
Please note that:
20+
* The Corporate CLA will always take precedence over the Individual CLA.
21+
* One CLA submission is sufficient, for any project proposed by STMicroelectronics.
22+
23+
__How to proceed__
24+
25+
* We recommend to fork the project in your GitHub account to further develop your contribution. Please use the latest commit version.
26+
* Please, submit one Pull Request for one new feature or proposal. This will ease the analysis and final merge if accepted.
27+
28+
__Note__
29+
30+
Merge will not be done directly in GitHub but it will need first to follow internal integration process before public deliver in a standard release. The Pull request will stay open until it is merged and delivered.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright 2021 STMicroelectronics.
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification,
5+
are permitted provided that the following conditions are met:
6+
7+
1. Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
2. Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation and/or
12+
other materials provided with the distribution.
13+
14+
3. Neither the name of the copyright holder nor the names of its contributors
15+
may be used to endorse or promote products derived from this software without
16+
specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
This software component is provided to you as part of a software package and
2+
applicable license terms are in the Package_license file. If you received this
3+
software component outside of a package or without applicable license terms,
4+
the terms of the BSD-3-Clause license shall apply.
5+
You may obtain a copy of the BSD-3-Clause at:
6+
https://opensource.org/licenses/BSD-3-Clause
Lines changed: 242 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="generator" content="pandoc" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
7+
<title>Release Notes for BSP Common Components Drivers</title>
8+
<style type="text/css">
9+
code{white-space: pre-wrap;}
10+
span.smallcaps{font-variant: small-caps;}
11+
span.underline{text-decoration: underline;}
12+
div.column{display: inline-block; vertical-align: top; width: 50%;}
13+
</style>
14+
<link rel="stylesheet" href="_htmresc/mini-st.css" />
15+
<!--[if lt IE 9]>
16+
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
17+
<![endif]-->
18+
<link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" />
19+
</head>
20+
<body>
21+
<div class="row">
22+
<div class="col-sm-12 col-lg-4">
23+
<center>
24+
<h1 id="release-notes-for-bsp-common-components-drivers"><small>Release Notes for</small> <mark>BSP Common Components Drivers</mark></h1>
25+
<p>Copyright © 2014 STMicroelectronics<br />
26+
</p>
27+
<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo.png" alt="ST logo" /></a>
28+
</center>
29+
<h1 id="purpose">Purpose</h1>
30+
<p>This directory contains the BSP Common components drivers.</p>
31+
</div>
32+
<div class="col-sm-12 col-lg-8">
33+
<h1 id="update-history">Update History</h1>
34+
<div class="collapse">
35+
<input type="checkbox" id="collapse-section19" checked aria-hidden="true"> <label for="collapse-section19" aria-hidden="true">V7.2.1 / 16-November-2021</label>
36+
<div>
37+
<h2 id="main-changes">Main Changes</h2>
38+
<h3 id="component-release">Component release</h3>
39+
<ul>
40+
<li>Update licensing</li>
41+
</ul>
42+
</div>
43+
</div>
44+
<div class="collapse">
45+
<input type="checkbox" id="collapse-section18" aria-hidden="true"> <label for="collapse-section18" aria-hidden="true">V7.2.0 / 11-October-2021</label>
46+
<div>
47+
<h2 id="main-changes-1">Main Changes</h2>
48+
<h3 id="component-release-1">Component release</h3>
49+
<ul>
50+
<li>Add hybrid_sensor.h to support hybrid (env and motion) sensors</li>
51+
</ul>
52+
</div>
53+
</div>
54+
<div class="collapse">
55+
<input type="checkbox" id="collapse-section17" aria-hidden="true"> <label for="collapse-section17" aria-hidden="true">V7.1.0 / 18-Juin-2021</label>
56+
<div>
57+
<h2 id="main-changes-2">Main Changes</h2>
58+
<h3 id="component-release-2">Component release</h3>
59+
<ul>
60+
<li>Add ranging_sensor.h to support ranging sensors</li>
61+
<li>Add light_sensor.h to support ambient light sensors</li>
62+
<li>Rename UTILS_LCD_Drv_t structure into LCD_UTILS_Drv_t</li>
63+
<li>Code spelling and formatting</li>
64+
</ul>
65+
<h2 id="backward-compatibility">Backward Compatibility</h2>
66+
<ul>
67+
<li>This release breaks compatibility with previous versions.</li>
68+
</ul>
69+
</div>
70+
</div>
71+
<div class="collapse">
72+
<input type="checkbox" id="collapse-section16" aria-hidden="true"> <label for="collapse-section16" aria-hidden="true">V7.0.0 / 25-February-2020</label>
73+
<div>
74+
<h2 id="main-changes-3">Main Changes</h2>
75+
<h3 id="component-release-3">Component release</h3>
76+
<ul>
77+
<li>Rename GUI_Drv_t structure into UTILS_LCD_Drv_t</li>
78+
</ul>
79+
<h2 id="backward-compatibility-1">Backward Compatibility</h2>
80+
<ul>
81+
<li>This release breaks compatibility with previous versions.</li>
82+
</ul>
83+
</div>
84+
</div>
85+
<div class="collapse">
86+
<input type="checkbox" id="collapse-section15" aria-hidden="true"> <label for="collapse-section15" aria-hidden="true">V6.0.1 / 15-October-2019</label>
87+
<div>
88+
<h2 id="main-changes-4">Main Changes</h2>
89+
<h3 id="component-release-4">Component release</h3>
90+
<ul>
91+
<li>Update st_logo.png inclusion path in Release notes.</li>
92+
</ul>
93+
</div>
94+
</div>
95+
<div class="collapse">
96+
<input type="checkbox" id="collapse-section14" aria-hidden="true"> <label for="collapse-section14" aria-hidden="true">V6.0.0 / 12-April-2019</label>
97+
<div>
98+
<h2 id="main-changes-5">Main Changes</h2>
99+
<h3 id="component-release-5">Component release</h3>
100+
<p>Official release of BSP Common components drivers in line with STM32Cube BSP drivers development guidelines (UM2298).</p>
101+
<h2 id="backward-compatibility-2">Backward Compatibility</h2>
102+
<p>This release breaks compatibility with previous versions.</p>
103+
</div>
104+
</div>
105+
<div class="collapse">
106+
<input type="checkbox" id="collapse-section13" aria-hidden="true"> <label for="collapse-section13" aria-hidden="true">V5.1.1 / 31-August-2018</label>
107+
<div>
108+
<h2 id="main-changes-6">Main Changes</h2>
109+
<p>Reformat the BSD 3-Clause license declaration in the files header (replace license terms by a web reference to OSI website where those terms lie)<br />
110+
Correct sensor names in headers files hsensor.h and psensor.h</p>
111+
</div>
112+
</div>
113+
<div class="collapse">
114+
<input type="checkbox" id="collapse-section12" aria-hidden="true"> <label for="collapse-section12" aria-hidden="true">V5.1.0 / 21-November-2017</label>
115+
<div>
116+
<h2 id="main-changes-7">Main Changes</h2>
117+
<p>Add dpredriver.h: support of DP redriver class<br />
118+
Add pwrmon.h: support of power monitor class<br />
119+
Add usbtypecswitch.h: support of USB type C switch class</p>
120+
</div>
121+
</div>
122+
<div class="collapse">
123+
<input type="checkbox" id="collapse-section11" aria-hidden="true"> <label for="collapse-section11" aria-hidden="true">V5.0.0 / 01-March-2017</label>
124+
<div>
125+
<h2 id="main-changes-8">Main Changes</h2>
126+
<p>Add hsensor.h: support of humidity class<br />
127+
Add psensor.h: support of pressure class<br />
128+
Update tsensor.h: Temperature can be negative<br />
129+
Update accelero.h: LowPower API can enable or disable the low power mode<br />
130+
Update magneto.h: LowPower API can enable or disable the low power mode</p>
131+
<h2 id="backward-compatibility-3">Backward Compatibility</h2>
132+
<p>This release breaks compatibility with previous versions.</p>
133+
</div>
134+
</div>
135+
<div class="collapse">
136+
<input type="checkbox" id="collapse-section10" aria-hidden="true"> <label for="collapse-section10" aria-hidden="true">V4.0.1 / 21-July-2015</label>
137+
<div>
138+
<h2 id="main-changes-9">Main Changes</h2>
139+
<p>tsensor.h: Fix compilation issue on <em>TSENSOR_InitTypeDef</em></p>
140+
</div>
141+
</div>
142+
<div class="collapse">
143+
<input type="checkbox" id="collapse-section9" aria-hidden="true"> <label for="collapse-section9" aria-hidden="true">V4.0.0 / 22-June-2015</label>
144+
<div>
145+
<h2 id="main-changes-10">Main Changes</h2>
146+
<p>accelero.h: add <em>DeInit</em> field in <em>ACCELERO_DrvTypeDef</em> structure<br />
147+
audio.h: add <em>DeInit</em> field in <em>AUDIO_DrvTypeDef</em> structure<br />
148+
idd.h:</p>
149+
<ul>
150+
<li>add <em>Shunt0StabDelay</em>, <em>Shunt1StabDelay</em>, <em>Shunt2StabDelay</em>, <em>Shunt3StabDelay</em>, <em>Shunt4StabDelay</em> and <em>ShuntNbOnBoard</em> fields in <em>IDD_ConfigTypeDef</em> structure<br />
151+
</li>
152+
<li>rename <em>ShuntNumber</em> field to <em>ShuntNbUsed</em> in <em>IDD_ConfigTypeDef</em> structure</li>
153+
</ul>
154+
<p>magneto.h: add <em>DeInit</em> field in <em>MAGNETO_DrvTypeDef</em> structure</p>
155+
<h2 id="backward-compatibility-4">Backward Compatibility</h2>
156+
<p>This release breaks compatibility with previous versions.</p>
157+
</div>
158+
</div>
159+
<div class="collapse">
160+
<input type="checkbox" id="collapse-section8" aria-hidden="true"> <label for="collapse-section8" aria-hidden="true">V3.0.0 / 28-April-2015</label>
161+
<div>
162+
<h2 id="main-changes-11">Main Changes</h2>
163+
<p>accelero.h: add <em>LowPower</em> field in <em>ACCELERO_DrvTypeDef</em> structure<br />
164+
magneto.h: add <em>LowPower</em> field in <em>MAGNETO_DrvTypeDef</em> structure<br />
165+
gyro.h: add <em>DeInit</em> and <em>LowPower</em> fields in <em>GYRO_DrvTypeDef</em> structure<br />
166+
camera.h: add CAMERA_COLOR_EFFECT_NONE define<br />
167+
idd.h:</p>
168+
<ul>
169+
<li>add <em>MeasureNb</em>, <em>DeltaDelayUnit</em> and <em>DeltaDelayValue</em> fields in <em>IDD_ConfigTypeDef</em> structure<br />
170+
</li>
171+
<li>rename <em>PreDelay</em> field to <em>PreDelayUnit</em> in <em>IDD_ConfigTypeDef</em> structure</li>
172+
</ul>
173+
<h2 id="backward-compatibility-5">Backward Compatibility</h2>
174+
<p>This release breaks compatibility with previous versions.</p>
175+
</div>
176+
</div>
177+
<div class="collapse">
178+
<input type="checkbox" id="collapse-section7" aria-hidden="true"> <label for="collapse-section7" aria-hidden="true">V2.2.0 / 09-February-2015</label>
179+
<div>
180+
<h2 id="main-changes-12">Main Changes</h2>
181+
<p>Magnetometer driver function prototypes added (magneto.h file)<br />
182+
Update “idd.h” file to provide DeInit() and WakeUp() services in IDD current measurement driver</p>
183+
</div>
184+
</div>
185+
<div class="collapse">
186+
<input type="checkbox" id="collapse-section6" aria-hidden="true"> <label for="collapse-section6" aria-hidden="true">V2.1.0 / 06-February-2015</label>
187+
<div>
188+
<h2 id="main-changes-13">Main Changes</h2>
189+
<p>IDD current measurement driver function prototypes added (idd.h file)<br />
190+
io.h: add new typedef enum IO_PinState with IO_PIN_RESET and IO_PIN_SET values</p>
191+
</div>
192+
</div>
193+
<div class="collapse">
194+
<input type="checkbox" id="collapse-section5" aria-hidden="true"> <label for="collapse-section5" aria-hidden="true">V2.0.0 / 15-December-2014</label>
195+
<div>
196+
<h2 id="main-changes-14">Main Changes</h2>
197+
<p>Update “io.h” file to support MFX (Multi Function eXpander) device available on some STM32 boards</p>
198+
<ul>
199+
<li>add new entries for <em>IO_ModeTypedef</em> enumeration structure</li>
200+
<li>update the <em>IO_DrvTypeDef</em> structure</li>
201+
<li>Update all return values and function parameters to uint32_t</li>
202+
<li>Add a return value for <em>Config</em> field</li>
203+
</ul>
204+
<h2 id="backward-compatibility-6">Backward Compatibility</h2>
205+
<p>This release breaks compatibility with previous versions.</p>
206+
</div>
207+
</div>
208+
<div class="collapse">
209+
<input type="checkbox" id="collapse-section4" aria-hidden="true"> <label for="collapse-section4" aria-hidden="true">V1.2.1 / 02-December-2014</label>
210+
<div>
211+
<h2 id="main-changes-15">Main Changes</h2>
212+
<p>gyro.h: change “__GIRO_H” by “__GYRO_H” to fix compilation issue under Mac OS</p>
213+
</div>
214+
</div>
215+
<div class="collapse">
216+
<input type="checkbox" id="collapse-section3" aria-hidden="true"> <label for="collapse-section3" aria-hidden="true">V1.2.0 / 18-June-2014</label>
217+
<div>
218+
<h2 id="main-changes-16">Main Changes</h2>
219+
<p>EPD (E Paper Display) driver function prototype added (epd.h file)</p>
220+
</div>
221+
</div>
222+
<div class="collapse">
223+
<input type="checkbox" id="collapse-section2" aria-hidden="true"> <label for="collapse-section2" aria-hidden="true">V1.1.0 / 21-March-2014</label>
224+
<div>
225+
<h2 id="main-changes-17">Main Changes</h2>
226+
<p>Temperature Sensor driver function prototype added</p>
227+
</div>
228+
</div>
229+
<div class="collapse">
230+
<input type="checkbox" id="collapse-section1" aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">V1.0.0 / 18-February-2014</label>
231+
<div>
232+
<h2 id="main-changes-18">Main Changes</h2>
233+
<p>First official release with Accelerometer, Audio, Camera, Gyroscope, IO, LCD and Touch Screen drivers function prototypes</p>
234+
</div>
235+
</div>
236+
</div>
237+
</div>
238+
<footer class="sticky">
239+
For complete documentation on <mark>STM32 Microcontrollers</mark> , visit: <a href="http://www.st.com/STM32">http://www.st.com/STM32</a>
240+
</footer>
241+
</body>
242+
</html>

0 commit comments

Comments
 (0)