Fix misspellings using codespell tool
This commit is contained in:
parent
20e1ee174d
commit
ae41782e1a
@ -66,11 +66,11 @@ The most heavily tested toolchain is "gcc-arm-embedded"
|
|||||||
https://launchpad.net/gcc-arm-embedded
|
https://launchpad.net/gcc-arm-embedded
|
||||||
|
|
||||||
Other toolchains _should_ work, but have not been nearly as well tested.
|
Other toolchains _should_ work, but have not been nearly as well tested.
|
||||||
Toolchains targetting linux, such as "gcc-arm-linux-gnu" or the like are
|
Toolchains targeting linux, such as "gcc-arm-linux-gnu" or the like are
|
||||||
_not_ appropriate.
|
_not_ appropriate.
|
||||||
|
|
||||||
_NOTE_ We recommend, that you use g-a-c version 2.8 2014q3 or newer
|
_NOTE_ We recommend, that you use g-a-c version 2.8 2014q3 or newer
|
||||||
to build all platforms covered by libopencm3 succesfully.
|
to build all platforms covered by libopencm3 successfully.
|
||||||
|
|
||||||
Building
|
Building
|
||||||
--------
|
--------
|
||||||
|
@ -57,7 +57,7 @@
|
|||||||
|
|
||||||
/** @defgroup CM3_mpu_type MPU TYPE register fields
|
/** @defgroup CM3_mpu_type MPU TYPE register fields
|
||||||
* @ingroup CM3_mpu_defines
|
* @ingroup CM3_mpu_defines
|
||||||
* The MPU_TYPE register is always avilable, even if the MPU is not implemented.
|
* The MPU_TYPE register is always available, even if the MPU is not implemented.
|
||||||
* In that case, the DREGION field will read as 0.
|
* In that case, the DREGION field will read as 0.
|
||||||
*@{*/
|
*@{*/
|
||||||
/** v6m/v7m only support a unified MPU (IREGION always 0) */
|
/** v6m/v7m only support a unified MPU (IREGION always 0) */
|
||||||
|
@ -215,7 +215,7 @@
|
|||||||
#define SCB_AIRCR_VECTKEYSTAT (0xFFFF << SCB_AIRCR_VECTKEYSTAT_LSB)
|
#define SCB_AIRCR_VECTKEYSTAT (0xFFFF << SCB_AIRCR_VECTKEYSTAT_LSB)
|
||||||
#define SCB_AIRCR_VECTKEY (0x05FA << SCB_AIRCR_VECTKEYSTAT_LSB)
|
#define SCB_AIRCR_VECTKEY (0x05FA << SCB_AIRCR_VECTKEYSTAT_LSB)
|
||||||
|
|
||||||
/* ENDIANESS Data endianness bit */
|
/* ENDIANNESS Data endianness bit */
|
||||||
#define SCB_AIRCR_ENDIANESS (1 << 15)
|
#define SCB_AIRCR_ENDIANESS (1 << 15)
|
||||||
|
|
||||||
/* Those defined only on ARMv7 and above */
|
/* Those defined only on ARMv7 and above */
|
||||||
|
@ -319,7 +319,7 @@
|
|||||||
#define UART_DMACTL_DMAERR (1 << 2)
|
#define UART_DMACTL_DMAERR (1 << 2)
|
||||||
/** Transmit DMA enable */
|
/** Transmit DMA enable */
|
||||||
#define UART_DMACTL_TXDMAE (1 << 1)
|
#define UART_DMACTL_TXDMAE (1 << 1)
|
||||||
/** Recieve DMA enable */
|
/** Receive DMA enable */
|
||||||
#define UART_DMACTL_RXDMAE (1 << 0)
|
#define UART_DMACTL_RXDMAE (1 << 0)
|
||||||
|
|
||||||
/* =============================================================================
|
/* =============================================================================
|
||||||
|
@ -287,7 +287,7 @@ specific memorymap.h header before including this header file.*/
|
|||||||
/* DMA: Direct memory access mode. (ADC1 and ADC3 only!) */
|
/* DMA: Direct memory access mode. (ADC1 and ADC3 only!) */
|
||||||
#define ADC_CR2_DMA (1 << 8)
|
#define ADC_CR2_DMA (1 << 8)
|
||||||
|
|
||||||
/* CONT: Continous conversion. */
|
/* CONT: Continuous conversion. */
|
||||||
#define ADC_CR2_CONT (1 << 1)
|
#define ADC_CR2_CONT (1 << 1)
|
||||||
|
|
||||||
/* ADON: A/D converter On/Off. */
|
/* ADON: A/D converter On/Off. */
|
||||||
|
@ -163,7 +163,7 @@ specific memorymap.h header before including this header file.*/
|
|||||||
/* Note: Bits [7:6] are reserved, and forced to 0 by hardware. */
|
/* Note: Bits [7:6] are reserved, and forced to 0 by hardware. */
|
||||||
|
|
||||||
/* FREQ[5:0]: Peripheral clock frequency (valid values: 2-36 MHz, 2-42 MHz for
|
/* FREQ[5:0]: Peripheral clock frequency (valid values: 2-36 MHz, 2-42 MHz for
|
||||||
* STM32F4 respectivly) */
|
* STM32F4 respectively) */
|
||||||
/****************************************************************************/
|
/****************************************************************************/
|
||||||
/** @defgroup i2c_clock I2C clock frequency settings
|
/** @defgroup i2c_clock I2C clock frequency settings
|
||||||
@ingroup i2c_defines
|
@ingroup i2c_defines
|
||||||
|
@ -273,7 +273,7 @@ and ADC2
|
|||||||
/* CAL: A/D Calibration. */
|
/* CAL: A/D Calibration. */
|
||||||
#define ADC_CR2_CAL (1 << 2)
|
#define ADC_CR2_CAL (1 << 2)
|
||||||
|
|
||||||
/* CONT: Continous conversion. */
|
/* CONT: Continuous conversion. */
|
||||||
#define ADC_CR2_CONT (1 << 1)
|
#define ADC_CR2_CONT (1 << 1)
|
||||||
|
|
||||||
/* ADON: A/D converter On/Off. */
|
/* ADON: A/D converter On/Off. */
|
||||||
|
@ -252,7 +252,7 @@
|
|||||||
/* ADDM7:7-bit Address Detection/4-bit Address Detection */
|
/* ADDM7:7-bit Address Detection/4-bit Address Detection */
|
||||||
#define USART_CR2_ADDM7 (1 << 4)
|
#define USART_CR2_ADDM7 (1 << 4)
|
||||||
|
|
||||||
/* ADD[3:0]: Addres of the usart node
|
/* ADD[3:0]: Address of the usart node
|
||||||
#define USART_CR2_ADD_MASK 0xF */
|
#define USART_CR2_ADD_MASK 0xF */
|
||||||
|
|
||||||
/* --- USART_CR3 values ---------------------------------------------------- */
|
/* --- USART_CR3 values ---------------------------------------------------- */
|
||||||
|
@ -241,7 +241,7 @@ LGPL License Terms @ref lgpl_license
|
|||||||
|
|
||||||
/* Note: Bits [7:2] are reserved and must be kept at reset value. */
|
/* Note: Bits [7:2] are reserved and must be kept at reset value. */
|
||||||
|
|
||||||
/* CONT: Continous conversion. */
|
/* CONT: Continuous conversion. */
|
||||||
#define ADC_CR2_CONT (1 << 1)
|
#define ADC_CR2_CONT (1 << 1)
|
||||||
|
|
||||||
/* ADON: A/D converter On/Off. */
|
/* ADON: A/D converter On/Off. */
|
||||||
|
@ -157,7 +157,7 @@ extern void usbd_ep_setup(usbd_device *usbd_dev, uint8_t addr, uint8_t type,
|
|||||||
/** Write a packet
|
/** Write a packet
|
||||||
* @param addr EP address (direction is ignored)
|
* @param addr EP address (direction is ignored)
|
||||||
* @param len # of bytes
|
* @param len # of bytes
|
||||||
* @return 0 if failed, len if succesful
|
* @return 0 if failed, len if successful
|
||||||
*/
|
*/
|
||||||
extern uint16_t usbd_ep_write_packet(usbd_device *usbd_dev, uint8_t addr,
|
extern uint16_t usbd_ep_write_packet(usbd_device *usbd_dev, uint8_t addr,
|
||||||
const void *buf, uint16_t len);
|
const void *buf, uint16_t len);
|
||||||
|
@ -13,7 +13,7 @@ Gareth McMullin <gareth@blacksphere.co.nz>
|
|||||||
@date 10 March 2013
|
@date 10 March 2013
|
||||||
|
|
||||||
A set of structure definitions for the USB control structures
|
A set of structure definitions for the USB control structures
|
||||||
defined in chapter 9 of the "Univeral Serial Bus Specification Revision 2.0"
|
defined in chapter 9 of the "Universal Serial Bus Specification Revision 2.0"
|
||||||
Available from the USB Implementers Forum - http://www.usb.org/
|
Available from the USB Implementers Forum - http://www.usb.org/
|
||||||
|
|
||||||
LGPL License Terms @ref lgpl_license
|
LGPL License Terms @ref lgpl_license
|
||||||
@ -48,7 +48,7 @@ LGPL License Terms @ref lgpl_license
|
|||||||
|
|
||||||
/*
|
/*
|
||||||
* This file contains structure definitions for the USB control structures
|
* This file contains structure definitions for the USB control structures
|
||||||
* defined in chapter 9 of the "Univeral Serial Bus Specification Revision 2.0"
|
* defined in chapter 9 of the "Universal Serial Bus Specification Revision 2.0"
|
||||||
* Available from the USB Implementers Forum - http://www.usb.org/
|
* Available from the USB Implementers Forum - http://www.usb.org/
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@
|
|||||||
* benchmarking performance of the code. If function fails, the cycle counter
|
* benchmarking performance of the code. If function fails, the cycle counter
|
||||||
* isn't available on this architecture.
|
* isn't available on this architecture.
|
||||||
*
|
*
|
||||||
* @returnd true, if success
|
* @return true, if success
|
||||||
*/
|
*/
|
||||||
bool dwt_enable_cycle_counter(void)
|
bool dwt_enable_cycle_counter(void)
|
||||||
{
|
{
|
||||||
|
@ -502,7 +502,7 @@ void gpio_toggle(uint32_t gpioport, uint8_t gpios)
|
|||||||
* serviced_irq |= GPIO4;
|
* serviced_irq |= GPIO4;
|
||||||
* }
|
* }
|
||||||
*
|
*
|
||||||
* // Clear the interupt flag for the processed IRQs
|
* // Clear the interrupt flag for the processed IRQs
|
||||||
* gpio_clear_interrupt_flag(GPIOF, serviced_irqs);
|
* gpio_clear_interrupt_flag(GPIOF, serviced_irqs);
|
||||||
* }
|
* }
|
||||||
* @endcode
|
* @endcode
|
||||||
|
@ -92,7 +92,7 @@ Alexandru Gagniuc <mr.nuke.me@gmail.com>
|
|||||||
* internal 16MHz oscillator.
|
* internal 16MHz oscillator.
|
||||||
*
|
*
|
||||||
* High-level routines update the system clock automatically.
|
* High-level routines update the system clock automatically.
|
||||||
* For read access, it is recommended to acces this variable via
|
* For read access, it is recommended to access this variable via
|
||||||
* @code
|
* @code
|
||||||
* rcc_get_system_clock_frequency();
|
* rcc_get_system_clock_frequency();
|
||||||
* @endcode
|
* @endcode
|
||||||
|
@ -256,7 +256,7 @@ void uart_clock_from_sysclk(uint32_t uart)
|
|||||||
*
|
*
|
||||||
* \brief <b>Sending and receiving data through the UART</b>
|
* \brief <b>Sending and receiving data through the UART</b>
|
||||||
*
|
*
|
||||||
* Primitives for sending and recieving data are provided, @ref uart_send() and
|
* Primitives for sending and receiving data are provided, @ref uart_send() and
|
||||||
* @ref uart_recv(). These primitives do not check if data can be transmitted
|
* @ref uart_recv(). These primitives do not check if data can be transmitted
|
||||||
* or wait for data. If waiting until data is available or can be transmitted is
|
* or wait for data. If waiting until data is available or can be transmitted is
|
||||||
* desired, blocking primitives are also available, @ref uart_send_blocking()
|
* desired, blocking primitives are also available, @ref uart_send_blocking()
|
||||||
@ -407,7 +407,7 @@ uint16_t uart_recv_blocking(uint32_t uart)
|
|||||||
* serviced_irq |= UART_INT_CTS;
|
* serviced_irq |= UART_INT_CTS;
|
||||||
* }
|
* }
|
||||||
*
|
*
|
||||||
* // Clear the interupt flag for the processed IRQs
|
* // Clear the interrupt flag for the processed IRQs
|
||||||
* uart_clear_interrupt_flag(UART0, serviced_irqs);
|
* uart_clear_interrupt_flag(UART0, serviced_irqs);
|
||||||
* }
|
* }
|
||||||
* @endcode
|
* @endcode
|
||||||
|
@ -93,7 +93,7 @@ void crypto_set_datatype(enum crypto_datatype datatype)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Set the algoritm for Encryption/decryption
|
* @brief Set the algorithm for Encryption/decryption
|
||||||
*
|
*
|
||||||
*@param[in] mode enum crypto_mode Mode of execution
|
*@param[in] mode enum crypto_mode Mode of execution
|
||||||
*/
|
*/
|
||||||
|
@ -236,7 +236,7 @@ After the number of bytes/words to be transferred has been completed, the
|
|||||||
original transfer block size, memory and peripheral base addresses are
|
original transfer block size, memory and peripheral base addresses are
|
||||||
reloaded and the process repeats.
|
reloaded and the process repeats.
|
||||||
|
|
||||||
@note This cannot be used with memory to memory mode, which is explictly
|
@note This cannot be used with memory to memory mode, which is explicitly
|
||||||
disabled here.
|
disabled here.
|
||||||
|
|
||||||
@param[in] dma unsigned int32. DMA controller base address: DMA1 or DMA2
|
@param[in] dma unsigned int32. DMA controller base address: DMA1 or DMA2
|
||||||
|
@ -164,7 +164,7 @@ uint8_t st_usbfs_ep_stall_get(usbd_device *dev, uint8_t addr)
|
|||||||
void st_usbfs_ep_nak_set(usbd_device *dev, uint8_t addr, uint8_t nak)
|
void st_usbfs_ep_nak_set(usbd_device *dev, uint8_t addr, uint8_t nak)
|
||||||
{
|
{
|
||||||
(void)dev;
|
(void)dev;
|
||||||
/* It does not make sence to force NAK on IN endpoints. */
|
/* It does not make sense to force NAK on IN endpoints. */
|
||||||
if (addr & 0x80) {
|
if (addr & 0x80) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
@ -64,7 +64,7 @@ void usart_set_baudrate(uint32_t usart, uint32_t baud)
|
|||||||
/*
|
/*
|
||||||
* Yes it is as simple as that. The reference manual is
|
* Yes it is as simple as that. The reference manual is
|
||||||
* talking about fractional calculation but it seems to be only
|
* talking about fractional calculation but it seems to be only
|
||||||
* marketting babble to sound awesome. It is nothing else but a
|
* marketing babble to sound awesome. It is nothing else but a
|
||||||
* simple divider to generate the correct baudrate.
|
* simple divider to generate the correct baudrate.
|
||||||
*
|
*
|
||||||
* Note: We round() the value rather than floor()ing it, for more
|
* Note: We round() the value rather than floor()ing it, for more
|
||||||
|
@ -145,7 +145,7 @@ void adc_disable_discontinuous_mode(uint32_t adc)
|
|||||||
/*---------------------------------------------------------------------------*/
|
/*---------------------------------------------------------------------------*/
|
||||||
/** @brief ADC Set conversion operation mode
|
/** @brief ADC Set conversion operation mode
|
||||||
*
|
*
|
||||||
* @note on SEQUENTIAL mode, the trigger event is neccesary to start conversion.
|
* @note on SEQUENTIAL mode, the trigger event is necessary to start conversion.
|
||||||
* @par
|
* @par
|
||||||
*
|
*
|
||||||
* @param[in] adc Unsigned int32. ADC base address (@ref adc_reg_base)
|
* @param[in] adc Unsigned int32. ADC base address (@ref adc_reg_base)
|
||||||
|
@ -102,7 +102,7 @@ static void efm32lg_ep_setup(usbd_device *usbd_dev, uint8_t addr, uint8_t type,
|
|||||||
{
|
{
|
||||||
/*
|
/*
|
||||||
* Configure endpoint address and type. Allocate FIFO memory for
|
* Configure endpoint address and type. Allocate FIFO memory for
|
||||||
* endpoint. Install callback funciton.
|
* endpoint. Install callback function.
|
||||||
*/
|
*/
|
||||||
uint8_t dir = addr & 0x80;
|
uint8_t dir = addr & 0x80;
|
||||||
addr &= 0x7f;
|
addr &= 0x7f;
|
||||||
|
@ -44,7 +44,7 @@ void stm32fx07_ep_setup(usbd_device *usbd_dev, uint8_t addr, uint8_t type,
|
|||||||
{
|
{
|
||||||
/*
|
/*
|
||||||
* Configure endpoint address and type. Allocate FIFO memory for
|
* Configure endpoint address and type. Allocate FIFO memory for
|
||||||
* endpoint. Install callback funciton.
|
* endpoint. Install callback function.
|
||||||
*/
|
*/
|
||||||
uint8_t dir = addr & 0x80;
|
uint8_t dir = addr & 0x80;
|
||||||
addr &= 0x7f;
|
addr &= 0x7f;
|
||||||
@ -179,7 +179,7 @@ uint8_t stm32fx07_ep_stall_get(usbd_device *usbd_dev, uint8_t addr)
|
|||||||
|
|
||||||
void stm32fx07_ep_nak_set(usbd_device *usbd_dev, uint8_t addr, uint8_t nak)
|
void stm32fx07_ep_nak_set(usbd_device *usbd_dev, uint8_t addr, uint8_t nak)
|
||||||
{
|
{
|
||||||
/* It does not make sence to force NAK on IN endpoints. */
|
/* It does not make sense to force NAK on IN endpoints. */
|
||||||
if (addr & 0x80) {
|
if (addr & 0x80) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
@ -193,7 +193,7 @@ static int usb_standard_get_descriptor(usbd_device *usbd_dev,
|
|||||||
return USBD_REQ_NOTSUPP;
|
return USBD_REQ_NOTSUPP;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Ths string is returned as UTF16, hence the
|
/* This string is returned as UTF16, hence the
|
||||||
* multiplication
|
* multiplication
|
||||||
*/
|
*/
|
||||||
sd->bLength = strlen(usbd_dev->strings[array_idx]) * 2 +
|
sd->bLength = strlen(usbd_dev->strings[array_idx]) * 2 +
|
||||||
|
@ -54,7 +54,7 @@ gcc
|
|||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
|
|
||||||
This module adds an extended support for GCC toolchain. This adds rules,
|
This module adds an extended support for GCC toolchain. This adds rules,
|
||||||
neccessary for compiling C and C++ files into elf binary, and rules for
|
necessary for compiling C and C++ files into elf binary, and rules for
|
||||||
generation of bin, hex, or srec output files for flashing.
|
generation of bin, hex, or srec output files for flashing.
|
||||||
|
|
||||||
Variables to control the build process (should be set in your makefile):
|
Variables to control the build process (should be set in your makefile):
|
||||||
@ -109,7 +109,7 @@ OPENCM3_LIBNAME (replaced)
|
|||||||
! Ensure that you have line 'LDLIBS += -l$(OPENCM3_LIBNAME)' in your makefile.
|
! Ensure that you have line 'LDLIBS += -l$(OPENCM3_LIBNAME)' in your makefile.
|
||||||
! Ensure that you have line 'LDFLAGS += -L$(OPENCM3_DIR)/lib' in your makefile.
|
! Ensure that you have line 'LDFLAGS += -L$(OPENCM3_DIR)/lib' in your makefile.
|
||||||
! Ensure that you have rule '$(OPENCM3_DIR)/lib/lib$(OPENCM3_LIBNAME).a:'
|
! Ensure that you have rule '$(OPENCM3_DIR)/lib/lib$(OPENCM3_LIBNAME).a:'
|
||||||
to be the library archive succesfully built when needed.
|
to be the library archive successfully built when needed.
|
||||||
|
|
||||||
Temporary variables that you should not use in your makefile:
|
Temporary variables that you should not use in your makefile:
|
||||||
-------------------------------------------------------------
|
-------------------------------------------------------------
|
||||||
|
@ -23,7 +23,7 @@ numbers.
|
|||||||
Code generation is chosen here because the resulting C code needs to be very
|
Code generation is chosen here because the resulting C code needs to be very
|
||||||
repetetive (definition of the IRQ numbers, function prototypes, weak fallback
|
repetetive (definition of the IRQ numbers, function prototypes, weak fallback
|
||||||
definition and vector table definition), all being very repetitive. No portable
|
definition and vector table definition), all being very repetitive. No portable
|
||||||
method to achive the same thing with C preprocessor is known to the author.
|
method to achieve the same thing with C preprocessor is known to the author.
|
||||||
(Neither is any non-portable method, for that matter.)"""
|
(Neither is any non-portable method, for that matter.)"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
@ -149,7 +149,7 @@ def main():
|
|||||||
remove = False
|
remove = False
|
||||||
infile = sys.argv[1]
|
infile = sys.argv[1]
|
||||||
if not infile.startswith('./include/libopencm3/') or not infile.endswith('/irq.json'):
|
if not infile.startswith('./include/libopencm3/') or not infile.endswith('/irq.json'):
|
||||||
raise ValueError("Arguent must match ./include/libopencm3/**/irq.json")
|
raise ValueError("Argument must match ./include/libopencm3/**/irq.json")
|
||||||
nvic_h = infile.replace('irq.json', 'nvic.h')
|
nvic_h = infile.replace('irq.json', 'nvic.h')
|
||||||
vector_nvic_c = infile.replace('./include/libopencm3/', './lib/').replace('irq.json', 'vector_nvic.c')
|
vector_nvic_c = infile.replace('./include/libopencm3/', './lib/').replace('irq.json', 'vector_nvic.c')
|
||||||
cmsis = infile.replace('irq.json', 'irqhandlers.h').replace('/libopencm3/', '/libopencmsis/')
|
cmsis = infile.replace('irq.json', 'irqhandlers.h').replace('/libopencm3/', '/libopencmsis/')
|
||||||
|
Loading…
x
Reference in New Issue
Block a user