190 lines
7.5 KiB
C
190 lines
7.5 KiB
C
/************************************************************************************
|
|
* arch/arm/src/lpc17xx/lpc17_ssp.h
|
|
*
|
|
* Copyright (C) 2010, 2012-2013 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* 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_LPC17XX_LPC17_SSP_H
|
|
#define __ARCH_ARM_SRC_LPC17XX_LPC17_SSP_H
|
|
|
|
/************************************************************************************
|
|
* Included Files
|
|
************************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <nuttx/spi/spi.h>
|
|
|
|
#include "chip/lpc17_ssp.h"
|
|
|
|
#if defined(CONFIG_LPC17_SSP0) || defined(CONFIG_LPC17_SSP1)
|
|
|
|
/************************************************************************************
|
|
* Pre-processor Definitions
|
|
************************************************************************************/
|
|
|
|
/************************************************************************************
|
|
* Public Types
|
|
************************************************************************************/
|
|
|
|
#ifndef __ASSEMBLY__
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/************************************************************************************
|
|
* Public Data
|
|
************************************************************************************/
|
|
|
|
/************************************************************************************
|
|
* Public Functions
|
|
************************************************************************************/
|
|
|
|
/************************************************************************************
|
|
* Name: lpc17_sspinitialize
|
|
*
|
|
* Description:
|
|
* Initialize the selected SSP port.
|
|
*
|
|
* Input Parameter:
|
|
* 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 *lpc17_sspinitialize(int port);
|
|
|
|
/************************************************************************************
|
|
* Name: lpc17_ssp0/ssp1select, lpc17_ssp0/ssp1status, and lpc17_ssp0/ssp1cmddata
|
|
*
|
|
* 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 lpc17_sspinitialize()) are provided by common LPC17xx logic. To use
|
|
* this common SPI logic on your board:
|
|
*
|
|
* 1. Provide logic in lpc17_boardinitialize() to configure SSP chip select pins.
|
|
* 2. Provide lpc17_ssp0/ssp1select() and lpc17_ssp0/ssp1status() 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
|
|
* lpc17_ssp0/ssp1cmddata() functions in your board-specific logic. These
|
|
* functions will perform cmd/data selection operations using GPIOs in the way
|
|
* your board is configured.
|
|
* 3. Add a call to lpc17_sspinitialize() in your low level application
|
|
* initialization logic
|
|
* 4. The handle returned by lpc17_sspinitialize() may then be used to bind the
|
|
* SSP driver to higher level logic (e.g., calling mmcsd_spislotinitialize(),
|
|
* for example, will bind the SSP driver to the SPI MMC/SD driver).
|
|
*
|
|
************************************************************************************/
|
|
|
|
#ifdef CONFIG_LPC17_SSP0
|
|
void lpc17_ssp0select(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool selected);
|
|
uint8_t lpc17_ssp0status(FAR struct spi_dev_s *dev, enum spi_dev_e devid);
|
|
#ifdef CONFIG_SPI_CMDDATA
|
|
int lpc17_ssp0cmddata(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool cmd);
|
|
#endif
|
|
#endif
|
|
|
|
#ifdef CONFIG_LPC17_SSP1
|
|
void lpc17_ssp1select(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool selected);
|
|
uint8_t lpc17_ssp1status(FAR struct spi_dev_s *dev, enum spi_dev_e devid);
|
|
#ifdef CONFIG_SPI_CMDDATA
|
|
int lpc17_ssp1cmddata(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool cmd);
|
|
#endif
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: ssp_flush
|
|
*
|
|
* Description:
|
|
* Flush and discard any words left in the RX fifo. This can be called
|
|
* from ssp0/1select after a device is deselected (if you worry about such
|
|
* things).
|
|
*
|
|
* Input Parameters:
|
|
* dev - Device-specific state data
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#if defined(CONFIG_LPC17_SSP0) || defined(CONFIG_LPC17_SSP1)
|
|
void ssp_flush(FAR struct spi_dev_s *dev);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_ssp0/1register
|
|
*
|
|
* 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(s) must
|
|
* must be implemented. These functiosn 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
|
|
#ifdef CONFIG_LPC17_SSP0
|
|
int lpc17_ssp0register(FAR struct spi_dev_s *dev, spi_mediachange_t callback,
|
|
FAR void *arg);
|
|
#endif
|
|
|
|
#ifdef CONFIG_LPC17_SSP1
|
|
int lpc17_ssp1register(FAR struct spi_dev_s *dev, spi_mediachange_t callback,
|
|
FAR void *arg);
|
|
#endif
|
|
#endif
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* CONFIG_LPC17_SSP0 || CONFIG_LPC17_SSP1 */
|
|
#endif /* __ARCH_ARM_SRC_LPC17XX_LPC17_SSP_H */
|