/************************************************************************************ * arch/arm/src/lpc313x/lpc313x_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_LPC313X_LPC313X_INTERNAL_H #define __ARCH_ARM_SRC_LPC313X_LPC313X_INTERNAL_H /************************************************************************************ * Included Files ************************************************************************************/ #include #include #include #include #include "up_internal.h" #include "chip.h" /************************************************************************************ * Definitions ************************************************************************************/ /* Configuration ********************************************************************/ /* NVIC priority levels *************************************************************/ /************************************************************************************ * Public Types ************************************************************************************/ /************************************************************************************ * Inline Functions ************************************************************************************/ #ifndef __ASSEMBLY__ /************************************************************************************ * Public Data ************************************************************************************/ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /************************************************************************************ * Public Function Prototypes ************************************************************************************/ /************************************************************************************ * Name: lpc313x_lowsetup * * Description: * Called early in up_boot. Performs chip-common low level initialization. * ************************************************************************************/ EXTERN void lpc313x_lowsetup(void); /************************************************************************************ * Name: lpc313x_clockconfig * * Description: * Called to change to new clock based on settings in board.h * ************************************************************************************/ EXTERN void lpc313x_clockconfig(void); /************************************************************************************ * Name: lpc313x_configgpio * * Description: * Configure a GPIO pin based on bit-encoded description of the pin. * ************************************************************************************/ EXTERN int lpc313x_configgpio(uint32_t cfgset); /************************************************************************************ * Name: lpc313x_gpiowrite * * Description: * Write one or zero to the selected GPIO pin * ************************************************************************************/ EXTERN void lpc313x_gpiowrite(uint32_t pinset, bool value); /************************************************************************************ * Name: lpc313x_gpioread * * Description: * Read one or zero from the selected GPIO pin * ************************************************************************************/ EXTERN bool lpc313x_gpioread(uint32_t pinset); /************************************************************************************ * Function: lpc313x_dumpgpio * * Description: * Dump all GPIO registers associated with the provided base address * ************************************************************************************/ #ifdef CONFIG_DEBUG EXTERN int lpc313x_dumpgpio(uint32_t pinset, const char *msg); #else # define lpc313x_dumpgpio(p,m) #endif /************************************************************************************ * Name: lpc313x_spiselect and lpc313x_spistatus * * Description: * The external functions, lpc313x_spiselect and lpc313x_spistatus 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 LPC313X logic. To use this common SPI logic on your * board: * * 1. Provide logic in lpc313x_boardinitialize() to configure SPI chip select * pins. * 2. Provide lpc313x_spiselect() and lpc313x_spistatus() 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 lpc313x_spiselect(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool selected); EXTERN uint8_t lpc313x_spistatus(FAR struct spi_dev_s *dev, enum spi_dev_e devid); /************************************************************************************ * Name: lpc313x_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 lpc313x_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 lpc313x_usbpullup(FAR struct usbdev_s *dev, bool enable); /************************************************************************************ * Name: lpc313x_usbsuspend * * Description: * Board logic must provide the lpc313x_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 lpc313x_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_LPC313X_LPC313X_INTERNAL_H */