/************************************************************************************ * arch/arm/src/lpc11xx/lpc11_spi.h * * Copyright (C) 2015 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_LPC11XX_LPC11_SPI_H #define __ARCH_ARM_SRC_LPC11XX_LPC11_SPI_H /************************************************************************************ * Included Files ************************************************************************************/ #include #include /************************************************************************************ * Public Data ************************************************************************************/ #ifdef CONFIG_LPC11_SPI #ifndef __ASSEMBLY__ #ifdef __cplusplus extern "C" { #endif /************************************************************************************ * Public Functions ************************************************************************************/ /************************************************************************************ * Name: lpc11_spibus_initialize * * Description: * Initialize the selected SPI port. * * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: * Valid SPI device structure reference on succcess; a NULL on failure * ************************************************************************************/ FAR struct spi_dev_s *lpc11_spibus_initialize(int port); /************************************************************************************ * Name: lpc11_spiselect, lpc11_status, and lpc11_spicmddata * * Description: * These external functions must be provided by board-specific logic. They are * implementations of the select, status, and cmddata methods of the SPI interface * defined by struct spi_ops_s (see include/nuttx/spi/spi.h). All other methods * including lpc11_spibus_initialize()) are provided by common LPC11xx logic. To use * this common SPI logic on your board: * * 1. Provide logic in lpc11_boardinitialize() to configure SPI chip select pins. * 2. Provide lpc11_spiselect() and lpc11_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. * 2. If CONFIG_SPI_CMDDATA is defined in the NuttX configuration, provide * lpc11_spicmddata() functions in your board-specific logic. This function * will perform cmd/data selection operations using GPIOs in the way your * board is configured. * 3. Add a call to lpc11_spibus_initialize() in your low level application * initialization logic * 4. The handle returned by lpc11_spibus_initialize() 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). * ************************************************************************************/ void lpc11_spiselect(FAR struct spi_dev_s *dev, uint32_t devid, bool selected); uint8_t lpc11_spistatus(FAR struct spi_dev_s *dev, uint32_t devid); #ifdef CONFIG_SPI_CMDDATA int lpc11_spicmddata(FAR struct spi_dev_s *dev, uint32_t devid, bool cmd); #endif /************************************************************************************ * Name: spi_flush * * Description: * Flush and discard any words left in the RX fifo. This can be called * from spiselect after a device is deselected (if you worry about such * things). * * Input Parameters: * dev - Device-specific state data * * Returned Value: * None * ************************************************************************************/ void spi_flush(FAR struct spi_dev_s *dev); /************************************************************************************ * Name: lpc11_spiregister * * Description: * If the board supports a card detect callback to inform the SPI-based * MMC/SD drvier when an SD card is inserted or removed, then * CONFIG_SPI_CALLBACK should be defined and the following function must * must be implemented. These functions implements the registercallback * method of the SPI interface (see include/nuttx/spi/spi.h for details) * * Input Parameters: * dev - Device-specific state data * callback - The funtion to call on the media change * arg - A caller provided value to return with the callback * * Returned Value: * 0 on success; negated errno on failure. * ************************************************************************************/ #ifdef CONFIG_SPI_CALLBACK int lpc11_spiregister(FAR struct spi_dev_s *dev, spi_mediachange_t callback, FAR void *arg); #endif #if defined(__cplusplus) } #endif #endif /* __ASSEMBLY__ */ #endif /* CONFIG_LPC11_SPI */ #endif /* __ARCH_ARM_SRC_LPC11XX_LPC11_SPI_H */