summaryrefslogtreecommitdiff
path: root/nuttx/arch/arm/src/lpc43xx/lpc43_spi.h
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-07-04 23:19:59 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2012-07-04 23:19:59 +0000
commitd2a5c3d4f5b9899dc5de05c49ede4e616fae9a64 (patch)
tree0069f942928564b5216301ec2623b1f102d46fb5 /nuttx/arch/arm/src/lpc43xx/lpc43_spi.h
parent08088bc230efd32182b46b42b42e2b5e7d83a265 (diff)
downloadpx4-nuttx-d2a5c3d4f5b9899dc5de05c49ede4e616fae9a64.tar.gz
px4-nuttx-d2a5c3d4f5b9899dc5de05c49ede4e616fae9a64.tar.bz2
px4-nuttx-d2a5c3d4f5b9899dc5de05c49ede4e616fae9a64.zip
STM32 PM update
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4908 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx/arch/arm/src/lpc43xx/lpc43_spi.h')
-rw-r--r--nuttx/arch/arm/src/lpc43xx/lpc43_spi.h179
1 files changed, 179 insertions, 0 deletions
diff --git a/nuttx/arch/arm/src/lpc43xx/lpc43_spi.h b/nuttx/arch/arm/src/lpc43xx/lpc43_spi.h
new file mode 100644
index 000000000..ba447a113
--- /dev/null
+++ b/nuttx/arch/arm/src/lpc43xx/lpc43_spi.h
@@ -0,0 +1,179 @@
+/************************************************************************************
+ * arch/arm/src/lpc43xx/lpc43_spi.h
+ *
+ * Copyright (C) 2012 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_LPC43XX_SPI_H
+#define __ARCH_ARM_SRC_LPC43XX_SPI_H
+
+/************************************************************************************
+ * Included Files
+ ************************************************************************************/
+
+#include <nuttx/config.h>
+#include <chip/lpc32_spi.h>
+
+#ifdef CONFIG_LPC43_SPI
+
+/************************************************************************************
+ * Pre-processor Definitions
+ ************************************************************************************/
+/* This header file defines interfaces to common SPI logic. To use this common SPI
+ * logic on your board:
+ *
+ * 1. Provide logic in lpc43_boardinitialize() to configure SPI chip select pins.
+ * 2. Provide the lpc43_spiselect() and lpc43_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. If CONFIG_SPI_CMDDATA is defined in the NuttX configuration, provide
+ * lpc43_spicmddata() functions in your board-specific logic. This
+ * function will perform cmd/data selection operations using GPIOs in the
+ * way your board is configured.
+ * 4. Your low level board initialization logic should call lpc43_sspiinitialize.
+ * 5. The handle returned by lpc43_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).
+ */
+
+/************************************************************************************
+ * Public Types
+ ************************************************************************************/
+
+/************************************************************************************
+ * Public Data
+ ************************************************************************************/
+
+#ifndef __ASSEMBLY__
+
+#undef EXTERN
+#if defined(__cplusplus)
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/************************************************************************************
+ * Public Functions
+ ************************************************************************************/
+
+/************************************************************************************
+ * Name: lpc43_spiinitialize
+ *
+ * Description:
+ * Initialize the SPI port
+ *
+ * Input Parameter:
+ * port Port number (must be zero)
+ *
+ * Returned Value:
+ * Valid SPI device structure reference on succcess; a NULL on failure
+ *
+ ************************************************************************************/
+
+EXTERN FAR struct spi_dev_s *lpc43_spiinitialize(int port);
+
+/************************************************************************************
+ * Name: lpc43_spiselect, lpc43_spistatus, and lpc43_spicmddata
+ *
+ * Description:
+ * These functions must be provided in your board-specific logic. The
+ * lpc43_spiselect function will perform chip selection and the lpc43_spistatus
+ * will perform status operations using GPIOs in the way your board is configured.
+ *
+ * If CONFIG_SPI_CMDDATA is defined in the NuttX configuration, then
+ * lpc43_spicmddata must also be provided. This functions performs cmd/data
+ * selection operations using GPIOs in the way your board is configured.
+ *
+ ************************************************************************************/
+
+EXTERN void lpc43_spiselect(FAR struct spi_dev_s *dev, enum spi_dev_e devid,
+ bool selected);
+EXTERN uint8_t lpc43_spistatus(FAR struct spi_dev_s *dev, enum spi_dev_e devid);
+
+#ifdef CONFIG_SPI_CMDDATA
+EXTERN int lpc43_spicmddata(FAR struct spi_dev_s *dev, enum spi_dev_e 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
+ *
+ ****************************************************************************/
+
+EXTERN void spi_flush(FAR struct spi_dev_s *dev);
+
+/****************************************************************************
+ * Name: lpc43_spi/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(s) must
+ * must be implemented. These functiosn implements the registercallback
+ * method of the SPI interface (see include/nuttx/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
+EXTERN int lpc43_spiregister(FAR struct spi_dev_s *dev,
+ spi_mediachange_t callback, void *arg);
+#endif
+
+#undef EXTERN
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* __ASSEMBLY__ */
+#endif /* CONFIG_LPC43_SPI */
+#endif /* __ARCH_ARM_SRC_LPC43XX_SPI_H */