Skip to content

Commit 9c1487c

Browse files
hierophecthierophect
committed
Python doc generator fixes
1 parent 10aac2b commit 9c1487c

9 files changed

Lines changed: 18 additions & 12 deletions

File tree

‎conf.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@
121121
"ports/nrf/nrfx",
122122
"ports/nrf/peripherals",
123123
"ports/nrf/usb",
124+
"ports/stm32f4/stm32cube",
125+
"ports/stm32f4/peripherals",
126+
"ports/stm32f4/ref",
127+
"ports/stm32f4/README.md",
124128
"ports/pic16bit",
125129
"ports/qemu-arm",
126130
"ports/stm32",

‎ports/stm32f4/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
##Not Done
1+
# CircuitPython Port To The ST Microelectronics STM32F4 Series
2+
3+
This is a port of CircuitPython to the STM32F4 series of chips.

‎ports/stm32f4/stm32cube/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
* is using in the C source code, usually in main.c. This file contains:
99
* - Configuration section that allows to select:
1010
* - The STM32F4xx device used in the target application
11-
* - To use or not the peripheral’s drivers in application code(i.e.
12-
* code will be based on direct access to peripheral’s registers
11+
* - To use or not the peripheral's drivers in application code(i.e.
12+
* code will be based on direct access to peripheral's registers
1313
* rather than drivers API), this option is controlled by
1414
* "#define USE_HAL_DRIVER"
1515
*

‎ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ HAL_StatusTypeDef HAL_CRYP_Init(CRYP_HandleTypeDef *hcryp)
463463
}
464464
#endif /* (USE_HAL_CRYP_REGISTER_CALLBACKS) */
465465

466-
/* Set the key size(This bit field is don’t care in the DES or TDES modes) data type and Algorithm */
466+
/* Set the key size(This bit field is don't care in the DES or TDES modes) data type and Algorithm */
467467
#if defined (CRYP)
468468

469469
MODIFY_REG(hcryp->Instance->CR, CRYP_CR_DATATYPE|CRYP_CR_KEYSIZE|CRYP_CR_ALGOMODE, hcryp->Init.DataType | hcryp->Init.KeySize | hcryp->Init.Algorithm);
@@ -578,7 +578,7 @@ HAL_StatusTypeDef HAL_CRYP_SetConfig(CRYP_HandleTypeDef *hcryp, CRYP_ConfigTypeD
578578
hcryp->Init.B0 = pConf->B0;
579579
hcryp->Init.DataWidthUnit = pConf->DataWidthUnit;
580580

581-
/* Set the key size(This bit field is don’t care in the DES or TDES modes) data type, AlgoMode and operating mode*/
581+
/* Set the key size(This bit field is don't care in the DES or TDES modes) data type, AlgoMode and operating mode*/
582582
#if defined (CRYP)
583583

584584
MODIFY_REG(hcryp->Instance->CR, CRYP_CR_DATATYPE|CRYP_CR_KEYSIZE|CRYP_CR_ALGOMODE, hcryp->Init.DataType | hcryp->Init.KeySize | hcryp->Init.Algorithm);

‎ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp_ex.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ HAL_StatusTypeDef HAL_CRYPEx_AESGCM_GenerateAuthTAG(CRYP_HandleTypeDef *hcryp, u
170170
/* Select final phase */
171171
MODIFY_REG(hcryp->Instance->CR, CRYP_CR_GCM_CCMPH, CRYP_PHASE_FINAL);
172172

173-
/*ALGODIR bit must be set to ‘0’.*/
173+
/*ALGODIR bit must be set to '0'.*/
174174
hcryp->Instance->CR &= ~CRYP_CR_ALGODIR;
175175

176176
/* Enable the CRYP peripheral */
@@ -388,7 +388,7 @@ HAL_StatusTypeDef HAL_CRYPEx_AESCCM_GenerateAuthTAG(CRYP_HandleTypeDef *hcryp, u
388388
/* Disable CRYP to start the final phase */
389389
__HAL_CRYP_DISABLE(hcryp);
390390

391-
/* Select final phase & ALGODIR bit must be set to ‘0’. */
391+
/* Select final phase & ALGODIR bit must be set to '0'. */
392392
MODIFY_REG(hcryp->Instance->CR, CRYP_CR_GCM_CCMPH|CRYP_CR_ALGODIR, CRYP_PHASE_FINAL|CRYP_OPERATINGMODE_ENCRYPT);
393393

394394
/* Enable the CRYP peripheral */

‎ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_spi.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@
214214
* @{
215215
*/
216216
#define SPI_DEFAULT_TIMEOUT 100U
217-
#define SPI_BSY_FLAG_WORKAROUND_TIMEOUT 1000U /*!< Timeout 1000 µs */
217+
#define SPI_BSY_FLAG_WORKAROUND_TIMEOUT 1000U /*!< Timeout 1000 us */
218218
/**
219219
* @}
220220
*/
@@ -3488,7 +3488,7 @@ static HAL_StatusTypeDef SPI_EndRxTransaction(SPI_HandleTypeDef *hspi, uint32_t
34883488
*/
34893489
static HAL_StatusTypeDef SPI_EndRxTxTransaction(SPI_HandleTypeDef *hspi, uint32_t Timeout, uint32_t Tickstart)
34903490
{
3491-
/* Timeout in µs */
3491+
/* Timeout in us */
34923492
__IO uint32_t count = SPI_BSY_FLAG_WORKAROUND_TIMEOUT * (SystemCoreClock / 24U / 1000000U);
34933493
/* Erratasheet: BSY bit may stay high at the end of a data transfer in Slave mode */
34943494
if (hspi->Init.Mode == SPI_MODE_MASTER)

‎ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_alarm_template.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
HAL_RTC_MODULE_ENABLED define in stm32f4xx_hal_conf.h
2222
2323
[..]
24-
(@) HAL RTC alarm and HAL RTC wakeup drivers can’t be used with low power modes:
24+
(@) HAL RTC alarm and HAL RTC wakeup drivers can't be used with low power modes:
2525
The wake up capability of the RTC may be intrusive in case of prior low power mode
2626
configuration requiring different wake up sources.
2727
Application/Example behavior is no more guaranteed

‎ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_wakeup_template.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
HAL_RTC_MODULE_ENABLED define in stm32f4xx_hal_conf.h
2323
2424
[..]
25-
(@) HAL RTC alarm and HAL RTC wakeup drivers can’t be used with low power modes:
25+
(@) HAL RTC alarm and HAL RTC wakeup drivers can't be used with low power modes:
2626
The wake up capability of the RTC may be intrusive in case of prior low power mode
2727
configuration requiring different wake up sources.
2828
Application/Example behavior is no more guaranteed

‎ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_wwdg.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
(++) max time (mS) = 1000 * (Counter - 0x40) / WWDG clock
3434
(+) Typical values:
3535
(++) Counter min (T[5;0] = 0x00) @56MHz (PCLK1) with zero prescaler:
36-
max timeout before reset: ~73.14µs
36+
max timeout before reset: ~73.14us
3737
(++) Counter max (T[5;0] = 0x3F) @56MHz (PCLK1) with prescaler dividing by 128:
3838
max timeout before reset: ~599.18ms
3939

0 commit comments

Comments
 (0)