From 9c1487cff6cf28364ddd212e0af0076a2b663d6f Mon Sep 17 00:00:00 2001 From: Hierophect Date: Tue, 23 Jul 2019 13:48:59 -0400 Subject: [PATCH] Python doc generator fixes --- conf.py | 4 ++++ ports/stm32f4/README.md | 4 +++- .../stm32cube/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h | 4 ++-- .../stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp.c | 4 ++-- .../STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp_ex.c | 4 ++-- .../stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_spi.c | 4 ++-- .../Src/stm32f4xx_hal_timebase_rtc_alarm_template.c | 2 +- .../Src/stm32f4xx_hal_timebase_rtc_wakeup_template.c | 2 +- .../stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_wwdg.c | 2 +- 9 files changed, 18 insertions(+), 12 deletions(-) diff --git a/conf.py b/conf.py index 8586573887..1ad6ed005b 100644 --- a/conf.py +++ b/conf.py @@ -121,6 +121,10 @@ exclude_patterns = ["**/build*", "ports/nrf/nrfx", "ports/nrf/peripherals", "ports/nrf/usb", + "ports/stm32f4/stm32cube", + "ports/stm32f4/peripherals", + "ports/stm32f4/ref", + "ports/stm32f4/README.md", "ports/pic16bit", "ports/qemu-arm", "ports/stm32", diff --git a/ports/stm32f4/README.md b/ports/stm32f4/README.md index 61d5bab54c..a860c01ce4 100644 --- a/ports/stm32f4/README.md +++ b/ports/stm32f4/README.md @@ -1 +1,3 @@ -##Not Done +# CircuitPython Port To The ST Microelectronics STM32F4 Series + +This is a port of CircuitPython to the STM32F4 series of chips. diff --git a/ports/stm32f4/stm32cube/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h b/ports/stm32f4/stm32cube/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h index d244b97af8..2730fc1123 100644 --- a/ports/stm32f4/stm32cube/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h +++ b/ports/stm32f4/stm32cube/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h @@ -8,8 +8,8 @@ * is using in the C source code, usually in main.c. This file contains: * - Configuration section that allows to select: * - The STM32F4xx device used in the target application - * - To use or not the peripheral’s drivers in application code(i.e. - * code will be based on direct access to peripheral’s registers + * - To use or not the peripheral's drivers in application code(i.e. + * code will be based on direct access to peripheral's registers * rather than drivers API), this option is controlled by * "#define USE_HAL_DRIVER" * diff --git a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp.c b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp.c index cbcaa1ce30..69d988a802 100644 --- a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp.c +++ b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp.c @@ -463,7 +463,7 @@ HAL_StatusTypeDef HAL_CRYP_Init(CRYP_HandleTypeDef *hcryp) } #endif /* (USE_HAL_CRYP_REGISTER_CALLBACKS) */ - /* Set the key size(This bit field is don’t care in the DES or TDES modes) data type and Algorithm */ + /* Set the key size(This bit field is don't care in the DES or TDES modes) data type and Algorithm */ #if defined (CRYP) 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 hcryp->Init.B0 = pConf->B0; hcryp->Init.DataWidthUnit = pConf->DataWidthUnit; - /* Set the key size(This bit field is don’t care in the DES or TDES modes) data type, AlgoMode and operating mode*/ + /* Set the key size(This bit field is don't care in the DES or TDES modes) data type, AlgoMode and operating mode*/ #if defined (CRYP) MODIFY_REG(hcryp->Instance->CR, CRYP_CR_DATATYPE|CRYP_CR_KEYSIZE|CRYP_CR_ALGOMODE, hcryp->Init.DataType | hcryp->Init.KeySize | hcryp->Init.Algorithm); diff --git a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp_ex.c b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp_ex.c index c84f690d48..7ae7abf5e4 100644 --- a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp_ex.c +++ b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_cryp_ex.c @@ -170,7 +170,7 @@ HAL_StatusTypeDef HAL_CRYPEx_AESGCM_GenerateAuthTAG(CRYP_HandleTypeDef *hcryp, u /* Select final phase */ MODIFY_REG(hcryp->Instance->CR, CRYP_CR_GCM_CCMPH, CRYP_PHASE_FINAL); - /*ALGODIR bit must be set to ‘0’.*/ + /*ALGODIR bit must be set to '0'.*/ hcryp->Instance->CR &= ~CRYP_CR_ALGODIR; /* Enable the CRYP peripheral */ @@ -388,7 +388,7 @@ HAL_StatusTypeDef HAL_CRYPEx_AESCCM_GenerateAuthTAG(CRYP_HandleTypeDef *hcryp, u /* Disable CRYP to start the final phase */ __HAL_CRYP_DISABLE(hcryp); - /* Select final phase & ALGODIR bit must be set to ‘0’. */ + /* Select final phase & ALGODIR bit must be set to '0'. */ MODIFY_REG(hcryp->Instance->CR, CRYP_CR_GCM_CCMPH|CRYP_CR_ALGODIR, CRYP_PHASE_FINAL|CRYP_OPERATINGMODE_ENCRYPT); /* Enable the CRYP peripheral */ diff --git a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_spi.c b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_spi.c index fbe57f4aed..5136feea65 100644 --- a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_spi.c +++ b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_spi.c @@ -214,7 +214,7 @@ * @{ */ #define SPI_DEFAULT_TIMEOUT 100U -#define SPI_BSY_FLAG_WORKAROUND_TIMEOUT 1000U /*!< Timeout 1000 µs */ +#define SPI_BSY_FLAG_WORKAROUND_TIMEOUT 1000U /*!< Timeout 1000 us */ /** * @} */ @@ -3488,7 +3488,7 @@ static HAL_StatusTypeDef SPI_EndRxTransaction(SPI_HandleTypeDef *hspi, uint32_t */ static HAL_StatusTypeDef SPI_EndRxTxTransaction(SPI_HandleTypeDef *hspi, uint32_t Timeout, uint32_t Tickstart) { - /* Timeout in µs */ + /* Timeout in us */ __IO uint32_t count = SPI_BSY_FLAG_WORKAROUND_TIMEOUT * (SystemCoreClock / 24U / 1000000U); /* Erratasheet: BSY bit may stay high at the end of a data transfer in Slave mode */ if (hspi->Init.Mode == SPI_MODE_MASTER) diff --git a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_alarm_template.c b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_alarm_template.c index 8e197a19b7..4e0daeaae3 100644 --- a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_alarm_template.c +++ b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_alarm_template.c @@ -21,7 +21,7 @@ HAL_RTC_MODULE_ENABLED define in stm32f4xx_hal_conf.h [..] - (@) HAL RTC alarm and HAL RTC wakeup drivers can’t be used with low power modes: + (@) HAL RTC alarm and HAL RTC wakeup drivers can't be used with low power modes: The wake up capability of the RTC may be intrusive in case of prior low power mode configuration requiring different wake up sources. Application/Example behavior is no more guaranteed diff --git a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_wakeup_template.c b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_wakeup_template.c index a047def223..fedd999157 100644 --- a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_wakeup_template.c +++ b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_timebase_rtc_wakeup_template.c @@ -22,7 +22,7 @@ HAL_RTC_MODULE_ENABLED define in stm32f4xx_hal_conf.h [..] - (@) HAL RTC alarm and HAL RTC wakeup drivers can’t be used with low power modes: + (@) HAL RTC alarm and HAL RTC wakeup drivers can't be used with low power modes: The wake up capability of the RTC may be intrusive in case of prior low power mode configuration requiring different wake up sources. Application/Example behavior is no more guaranteed diff --git a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_wwdg.c b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_wwdg.c index 0c43ba7668..6b5018c800 100644 --- a/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_wwdg.c +++ b/ports/stm32f4/stm32cube/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_wwdg.c @@ -33,7 +33,7 @@ (++) max time (mS) = 1000 * (Counter - 0x40) / WWDG clock (+) Typical values: (++) Counter min (T[5;0] = 0x00) @56MHz (PCLK1) with zero prescaler: - max timeout before reset: ~73.14µs + max timeout before reset: ~73.14us (++) Counter max (T[5;0] = 0x3F) @56MHz (PCLK1) with prescaler dividing by 128: max timeout before reset: ~599.18ms