/************************************************************************************ * arch/arm/src/stm32/stm32_internal.h * * Copyright (C) 2009 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ************************************************************************************/ #ifndef __ARCH_ARM_SRC_STM32_STM32_INTERNAL_H #define __ARCH_ARM_SRC_STM32_STM32_INTERNAL_H /************************************************************************************ * Included Files ************************************************************************************/ #include #include #include #include #include "up_internal.h" #include "chip.h" /************************************************************************************ * Definitions ************************************************************************************/ /* Configuration ********************************************************************/ #if !defined(CONFIG_DEBUG) || !defined(CONFIG_DEBUG_VERBOSE) # undef CONFIG_DEBUG_DMA #endif /* NVIC priority levels *************************************************************/ #define NVIC_SYSH_PRIORITY_MIN 0xff /* All bits set in minimum priority */ #define NVIC_SYSH_PRIORITY_DEFAULT 0x80 /* Midpoint is the default */ #define NVIC_SYSH_PRIORITY_MAX 0x00 /* Zero is maximum priority */ /* Bit-encoded input to stm32_configgpio() *******************************************/ /* 16-bit Encoding: * OFFS SX.. VPPP BBBB */ /* Output mode: * * O... .... .... .... */ #define GPIO_INPUT (1 << 15) /* Bit 15: 1=Input mode */ #define GPIO_OUTPUT (0) /* 0=Output or alternate function */ #define GPIO_ALT (0) /* These bits set the primary function of the pin: * .FF. .... .... .... */ #define GPIO_CNF_SHIFT 13 /* Bits 13-14: GPIO function */ #define GPIO_CNF_MASK (3 << GPIO_CNF_SHIFT) # define GPIO_CNF_ANALOGIN (0 << GPIO_CNF_SHIFT) /* Analog input */ # define GPIO_CNF_INFLOAT (1 << GPIO_CNF_SHIFT) /* Input floating */ # define GPIO_CNF_INPULLUP (2 << GPIO_CNF_SHIFT) /* Input pull-up */ # define GPIO_CNF_INPULLDWN (3 << GPIO_CNF_SHIFT) /* Input pull-down */ # define GPIO_CNF_OUTPP (0 << GPIO_CNF_SHIFT) /* Output push-pull */ # define GPIO_CNF_OUTOD (1 << GPIO_CNF_SHIFT) /* Output open-drain */ # define GPIO_CNF_AFPP (2 << GPIO_CNF_SHIFT) /* Alternate function push-pull */ # define GPIO_CNF_AFOD (3 << GPIO_CNF_SHIFT) /* Alternate function open-drain */ /* Maximum frequency selection: * ...S S... .... .... */ #define GPIO_MODE_SHIFT 11 /* Bits 11-12: GPIO frequency selection */ #define GPIO_MODE_MASK (3 << GPIO_MODE_SHIFT) # define GPIO_MODE_INPUT (0 << GPIO_MODE_SHIFT) /* Input mode (reset state) */ # define GPIO_MODE_10MHz (1 << GPIO_MODE_SHIFT) /* Output mode, max speed 10 MHz */ # define GPIO_MODE_2MHz (2 << GPIO_MODE_SHIFT) /* Output mode, max speed 2 MHz */ # define GPIO_MODE_50MHz (3 << GPIO_MODE_SHIFT) /* Output mode, max speed 50 MHz */ /* External interrupt selection (GPIO inputs only): * .... .X.. .... .... */ #define GPIO_EXTI (1 << 10) /* Bit 10: Configure as EXTI interrupt */ /* If the pin is an GPIO digital output, then this identifies the initial output value: * .... .... V... .... */ #define GPIO_OUTPUT_SET (1 << 7) /* Bit 7: If output, inital value of output */ #define GPIO_OUTPUT_CLEAR (0) /* This identifies the GPIO port: * .... .... .PPP .... */ #define GPIO_PORT_SHIFT 4 /* Bit 4-6: Port number */ #define GPIO_PORT_MASK (7 << GPIO_PORT_SHIFT) #define GPIO_PORTA (0 << GPIO_PORT_SHIFT) /* GPIOA */ #define GPIO_PORTB (1 << GPIO_PORT_SHIFT) /* GPIOB */ #define GPIO_PORTC (2 << GPIO_PORT_SHIFT) /* GPIOC */ #define GPIO_PORTD (3 << GPIO_PORT_SHIFT) /* GPIOD */ #define GPIO_PORTE (4 << GPIO_PORT_SHIFT) /* GPIOE */ #define GPIO_PORTF (5 << GPIO_PORT_SHIFT) /* GPIOF */ #define GPIO_PORTG (6 << GPIO_PORT_SHIFT) /* GPIOG */ /* This identifies the bit in the port: * .... .... .... BBBB */ #define GPIO_PIN_SHIFT 0 /* Bits 0-3: GPIO number: 0-15 */ #define GPIO_PIN_MASK (15 << GPIO_PIN_SHIFT) #define GPIO_PIN0 (0 << GPIO_PIN_SHIFT) #define GPIO_PIN1 (1 << GPIO_PIN_SHIFT) #define GPIO_PIN2 (2 << GPIO_PIN_SHIFT) #define GPIO_PIN3 (3 << GPIO_PIN_SHIFT) #define GPIO_PIN4 (4 << GPIO_PIN_SHIFT) #define GPIO_PIN5 (5 << GPIO_PIN_SHIFT) #define GPIO_PIN6 (6 << GPIO_PIN_SHIFT) #define GPIO_PIN7 (7 << GPIO_PIN_SHIFT) #define GPIO_PIN8 (8 << GPIO_PIN_SHIFT) #define GPIO_PIN9 (9 << GPIO_PIN_SHIFT) #define GPIO_PIN10 (10 << GPIO_PIN_SHIFT) #define GPIO_PIN11 (11 << GPIO_PIN_SHIFT) #define GPIO_PIN12 (12 << GPIO_PIN_SHIFT) #define GPIO_PIN13 (13 << GPIO_PIN_SHIFT) #define GPIO_PIN14 (14 << GPIO_PIN_SHIFT) #define GPIO_PIN15 (15 << GPIO_PIN_SHIFT) /* Alternate function pin-mapping ***************************************************/ /* Each GPIO pin may serve either for general purpose I/O or for a special alternate * function (such as USART, CAN, USB, SDIO, etc.). That particular pin-mapping will * depend on the package and STM32 family. If you are incorporating a new STM32 * chip into NuttX, you will need to add the pin-mapping to a header file and to * include that header file. NOTE: You can get the chip-specific pin-mapping info * from the chip datasheet. */ #if defined(CONFIG_ARCH_CHIP_STM32F103ZET6) # include "stm32f103ze_pinmap.h" #elif defined(CONFIG_ARCH_CHIP_STM32F107VC) # include "stm32f107vc_pinmap.h" #endif /************************************************************************************ * Public Types ************************************************************************************/ typedef FAR void *DMA_HANDLE; typedef void (*dma_callback_t)(DMA_HANDLE handle, uint8_t isr, void *arg); #ifdef CONFIG_DEBUG_DMA struct stm32_dmaregs_s { uint32_t isr; uint32_t ccr; uint32_t cndtr; uint32_t cpar; uint32_t cmar; }; #endif /************************************************************************************ * Inline Functions ************************************************************************************/ #ifndef __ASSEMBLY__ /************************************************************************************ * Public Data ************************************************************************************/ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /* This symbol references the Cortex-M3 vector table (as positioned by the the linker * script, ld.script or ld.script.dfu. The standard location for the vector table is * at the beginning of FLASH at address 0x0800:0000. If we are using the STMicro DFU * bootloader, then the vector table will be offset to a different location in FLASH * and we will need to set the NVIC vector location to this alternative location. */ extern uint32_t stm32_vectors[]; /* See stm32_vectors.S */ /************************************************************************************ * Public Function Prototypes ************************************************************************************/ /************************************************************************************ * Name: stm32_lowsetup * * Description: * Called at the very beginning of _start. Performs low level initialization. * ************************************************************************************/ EXTERN void stm32_lowsetup(void); /************************************************************************************ * Name: stm32_clockconfig * * Description: * Called to change to new clock based on settings in board.h * ************************************************************************************/ EXTERN void stm32_clockconfig(void); /************************************************************************************ * Name: stm32_configgpio * * Description: * Configure a GPIO pin based on bit-encoded description of the pin. * ************************************************************************************/ EXTERN int stm32_configgpio(uint32_t cfgset); /************************************************************************************ * Name: stm32_gpiowrite * * Description: * Write one or zero to the selected GPIO pin * ************************************************************************************/ EXTERN void stm32_gpiowrite(uint32_t pinset, bool value); /************************************************************************************ * Name: stm32_gpioread * * Description: * Read one or zero from the selected GPIO pin * ************************************************************************************/ EXTERN bool stm32_gpioread(uint32_t pinset); /************************************************************************************ * Function: stm32_dumpgpio * * Description: * Dump all GPIO registers associated with the provided base address * ************************************************************************************/ #ifdef CONFIG_DEBUG EXTERN int stm32_dumpgpio(uint32_t pinset, const char *msg); #else # define stm32_dumpgpio(p,m) #endif /**************************************************************************** * Name: stm32_dmachannel * * Description: * Allocate a DMA channel. This function gives the caller mutually * exclusive access to the DMA channel specified by the 'chan' argument. * DMA channels are shared on the STM32: Devices sharing the same DMA * channel cannot do DMA concurrently! See the DMACHAN_* definitions in * stm32_dma.h. * * If the DMA channel is not available, then stm32_dmachannel() will wait * until the holder of the channel relinquishes the channel by calling * stm32_dmafree(). WARNING: If you have two devices sharing a DMA * channel and the code never releases the channel, the stm32_dmachannel * call for the other will hang forever in this function! Don't let your * design do that! * * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * * Returned Value: * Provided that 'chan' is valid, this function ALWAYS returns a non-NULL, * void* DMA channel handle. (If 'chan' is invalid, the function will * assert if debug is enabled or do something ignorant otherwise). * * Assumptions: * - The caller does not hold he DMA channel. * - The caller can wait for the DMA channel to be freed if it is no * available. * ****************************************************************************/ EXTERN DMA_HANDLE stm32_dmachannel(int chan); /**************************************************************************** * Name: stm32_dmafree * * Description: * Release a DMA channel. If another thread is waiting for this DMA channel * in a call to stm32_dmachannel, then this function will re-assign the * DMA channel to that thread and wake it up. NOTE: The 'handle' used * in this argument must NEVER be used again until stm32_dmachannel() is * called again to re-gain access to the channel. * * Returned Value: * None * * Assumptions: * - The caller holds the DMA channel. * - There is no DMA in progress * ****************************************************************************/ EXTERN void stm32_dmafree(DMA_HANDLE handle); /**************************************************************************** * Name: stm32_dmasetup * * Description: * Configure DMA before using * ****************************************************************************/ EXTERN void stm32_dmasetup(DMA_HANDLE handle, uint32_t paddr, uint32_t maddr, size_t ntransfers, uint32_t ccr); /**************************************************************************** * Name: stm32_dmastart * * Description: * Start the DMA transfer * * Assumptions: * - DMA handle allocated by stm32_dmachannel() * - No DMA in progress * ****************************************************************************/ EXTERN void stm32_dmastart(DMA_HANDLE handle, dma_callback_t callback, void *arg, bool half); /**************************************************************************** * Name: stm32_dmastop * * Description: * Cancel the DMA. After stm32_dmastop() is called, the DMA channel is * reset and stm32_dmasetup() must be called before stm32_dmastart() can be * called again * * Assumptions: * - DMA handle allocated by stm32_dmachannel() * ****************************************************************************/ EXTERN void stm32_dmastop(DMA_HANDLE handle); /**************************************************************************** * Name: stm32_dmasample * * Description: * Sample DMA register contents * * Assumptions: * - DMA handle allocated by stm32_dmachannel() * ****************************************************************************/ #ifdef CONFIG_DEBUG_DMA EXTERN void stm32_dmasample(DMA_HANDLE handle, struct stm32_dmaregs_s *regs); #else # define stm32_dmasample(handle,regs) #endif /**************************************************************************** * Name: stm32_dmadump * * Description: * Dump previously sampled DMA register contents * * Assumptions: * - DMA handle allocated by stm32_dmachannel() * ****************************************************************************/ #ifdef CONFIG_DEBUG_DMA EXTERN void stm32_dmadump(DMA_HANDLE handle, const struct stm32_dmaregs_s *regs, const char *msg); #else # define stm32_dmadump(handle,regs,msg) #endif /************************************************************************************ * Function: stm32_ethinitialize * * Description: * Initialize the Ethernet driver for one interface. If the STM32 chip * supports multiple Ethernet controllers, then bould specific logic * must implement up_netinitialize() and call this function to initialize * the desiresed interfaces. * * Parameters: * None * * Returned Value: * OK on success; Negated errno on failure. * * Assumptions: * ************************************************************************************/ #if STM32_NTHERNET > 1 EXTERN int stm32_ethinitialize(int intf); #endif /************************************************************************************ * Name: stm32_spi1/2/3select and stm32_spi1/2/3status * * Description: * The external functions, stm32_spi1/2/3select and stm32_spi1/2/3status must be * provided by board-specific logic. They are implementations of the select * and status methods of the SPI interface defined by struct spi_ops_s (see * include/nuttx/spi.h). All other methods (including up_spiinitialize()) * are provided by common STM32 logic. To use this common SPI logic on your * board: * * 1. Provide logic in stm32_boardinitialize() to configure SPI chip select * pins. * 2. Provide stm32_spi1/2/3select() and stm32_spi1/2/3status() functions in your * board-specific logic. These functions will perform chip selection and * status operations using GPIOs in the way your board is configured. * 3. Add a calls to up_spiinitialize() in your low level application * initialization logic * 4. The handle returned by up_spiinitialize() may then be used to bind the * SPI driver to higher level logic (e.g., calling * mmcsd_spislotinitialize(), for example, will bind the SPI driver to * the SPI MMC/SD driver). * ************************************************************************************/ struct spi_dev_s; enum spi_dev_e; EXTERN void stm32_spi1select(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool selected); EXTERN uint8_t stm32_spi1status(FAR struct spi_dev_s *dev, enum spi_dev_e devid); EXTERN void stm32_spi2select(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool selected); EXTERN uint8_t stm32_spi2status(FAR struct spi_dev_s *dev, enum spi_dev_e devid); EXTERN void stm32_spi3select(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool selected); EXTERN uint8_t stm32_spi3status(FAR struct spi_dev_s *dev, enum spi_dev_e devid); /************************************************************************************ * Name: stm32_usbpullup * * Description: * If USB is supported and the board supports a pullup via GPIO (for USB software * connect and disconnect), then the board software must provide stm32_pullup. * See include/nuttx/usbdev.h for additional description of this method. * Alternatively, if no pull-up GPIO the following EXTERN can be redefined to be * NULL. * ************************************************************************************/ struct usbdev_s; EXTERN int stm32_usbpullup(FAR struct usbdev_s *dev, bool enable); /************************************************************************************ * Name: stm32_usbsuspend * * Description: * Board logic must provide the stm32_usbsuspend logic if the USBDEV driver is * used. This function is called whenever the USB enters or leaves suspend mode. * This is an opportunity for the board logic to shutdown clocks, power, etc. * while the USB is suspended. * ************************************************************************************/ struct usbdev_s; EXTERN void stm32_usbsuspend(FAR struct usbdev_s *dev, bool resume); /**************************************************************************** * Name: sdio_initialize * * Description: * Initialize SDIO for operation. * * Input Parameters: * slotno - Not used. * * Returned Values: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ struct sdio_dev_s; /* See include/nuttx/sdio.h */ EXTERN FAR struct sdio_dev_s *sdio_initialize(int slotno); /**************************************************************************** * Name: sdio_mediachange * * Description: * Called by board-specific logic -- posssible from an interrupt handler -- * in order to signal to the driver that a card has been inserted or * removed from the slot * * Input Parameters: * dev - An instance of the SDIO driver device state structure. * cardinslot - true is a card has been detected in the slot; false if a * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * * Returned Values: * None * ****************************************************************************/ EXTERN void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot); /**************************************************************************** * Name: sdio_wrprotect * * Description: * Called by board-specific logic to report if the card in the slot is * mechanically write protected. * * Input Parameters: * dev - An instance of the SDIO driver device state structure. * wrprotect - true is a card is writeprotected. * * Returned Values: * None * ****************************************************************************/ EXTERN void sdio_wrprotect(FAR struct sdio_dev_s *dev, bool wrprotect); #undef EXTERN #if defined(__cplusplus) } #endif #endif /* __ASSEMBLY__ */ #endif /* __ARCH_ARM_SRC_STM32_STM32_INTERNAL_H */