diff options
Diffstat (limited to 'nuttx/arch/arm/src/sam34/sam_spi.h')
| -rw-r--r-- | nuttx/arch/arm/src/sam34/sam_spi.h | 122 |
1 files changed, 84 insertions, 38 deletions
diff --git a/nuttx/arch/arm/src/sam34/sam_spi.h b/nuttx/arch/arm/src/sam34/sam_spi.h index 0c0d0d41d..45f4e0408 100644 --- a/nuttx/arch/arm/src/sam34/sam_spi.h +++ b/nuttx/arch/arm/src/sam34/sam_spi.h @@ -1,7 +1,7 @@ -/************************************************************************************ +/**************************************************************************** * arch/arm/src/sam34/sam_spi.h * - * Copyright (C) 2009-2011, 2013 Gregory Nutt. All rights reserved. + * Copyright (C) 2009-2011, 2013-2014 Gregory Nutt. All rights reserved. * Author: Gregory Nutt <gnutt@nuttx.org> * * Redistribution and use in source and binary forms, with or without @@ -31,14 +31,14 @@ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - ************************************************************************************/ + ****************************************************************************/ #ifndef __ARCH_ARM_SRC_SAM34_SAM_SPI_H #define __ARCH_ARM_SRC_SAM34_SAM_SPI_H -/************************************************************************************ +/**************************************************************************** * Included Files - ************************************************************************************/ + ****************************************************************************/ #include <nuttx/config.h> @@ -47,23 +47,53 @@ #include "chip.h" -/************************************************************************************ - * Definitions - ************************************************************************************/ +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +/* The SPI port number used as an input to up_spiinitialize encodes + * information about the SPI controller (0 or 1) and the SPI chip select + * (0-3). + * + * NOTE that this is this is backward compatible with older implementations + * that support only SPI0 and provide only the chip select number to + * up_spiinitialize(). + */ + +#define __SPI_CS_SHIFT (0) /* Bits 0-1: SPI chip select number */ +#define __SPI_CS_MASK (3 << __SPI_CS_SHIFT) +# define __SPI_CS0 (0 << __SPI_CS_SHIFT) +# define __SPI_CS1 (1 << __SPI_CS_SHIFT) +# define __SPI_CS2 (2 << __SPI_CS_SHIFT) +# define __SPI_CS3 (3 << __SPI_CS_SHIFT) +#define __SPI_SPI_SHIFT (2) /* Bit 2: SPI controller number */ +#define __SPI_SPI_MASK (1 << __SPI_SPI_SHIFT) +# define __SPI_SPI0 (0 << __SPI_SPI_SHIFT) /* SPI0 */ +# define __SPI_SPI1 (1 << __SPI_SPI_SHIFT) /* SPI1 */ + +#define SPI0_CS0 (__SPI_SPI0 | __SPI_CS0) +#define SPI0_CS1 (__SPI_SPI0 | __SPI_CS1) +#define SPI0_CS2 (__SPI_SPI0 | __SPI_CS2) +#define SPI0_CS3 (__SPI_SPI0 | __SPI_CS3) + +#define SPI1_CS0 (__SPI_SPI1 | __SPI_CS0) +#define SPI1_CS1 (__SPI_SPI1 | __SPI_CS1) +#define SPI1_CS2 (__SPI_SPI1 | __SPI_CS2) +#define SPI1_CS3 (__SPI_SPI1 | __SPI_CS3) -/************************************************************************************ +/**************************************************************************** * Public Types - ************************************************************************************/ + ****************************************************************************/ -/************************************************************************************ +/**************************************************************************** * Inline Functions - ************************************************************************************/ + ****************************************************************************/ #ifndef __ASSEMBLY__ -/************************************************************************************ +/**************************************************************************** * Public Data - ************************************************************************************/ + ****************************************************************************/ #undef EXTERN #if defined(__cplusplus) @@ -74,33 +104,34 @@ extern "C" #define EXTERN extern #endif -/************************************************************************************ +/**************************************************************************** * Public Function Prototypes - ************************************************************************************/ + ****************************************************************************/ /**************************************************************************** - * Name: sam_spiselect, sam_spistatus, and sam_spicmddata + * Name: sam_spi[0|1]select, sam_spi[0|1]status, and sam_spi[0|1]cmddata * * Description: - * These external functions must be provided by board-specific logic. They - * include: - * - * o sam_spiselect is a functions tomanage the board-specific chip selects - * o sam_spistatus and sam_spicmddata: Implementations of the status - * and cmddata methods of the SPI interface defined by struct spi_ops_ - * (see include/nuttx/spi/spi.h). All other methods including + * These external functions must be provided by board-specific logic. + * They include: + * + * o sam_spi[0|1]select is a functions tomanage the board-specific chip + * selects + * o sam_spi[0|1]status and sam_spi[0|1]cmddata: Implementations of the + * status and cmddata methods of the SPI interface defined by struct + * spi_ops_ (see include/nuttx/spi/spi.h). All other methods including * up_spiinitialize()) are provided by common SAM3/4 logic. * * To use this common SPI logic on your board: * * 1. Provide logic in sam_boardinitialize() to configure SPI chip select * pins. - * 2. Provide sam_spiselect() and sam_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. Provide sam_spi[0|1]select() and sam_spi[0|1]status() functions in + * our board-specific logic. These functions will perform chip selection + * and status operations using PIOs in the way your board is configured. * 2. If CONFIG_SPI_CMDDATA is defined in the NuttX configuration, provide - * sam_spicmddata() functions in your board-specific logic. This - * function will perform cmd/data selection operations using GPIOs in + * sam_spi[0|1]cmddata() functions in your board-specific logic. This + * function will perform cmd/data selection operations using PIOs in * the way your board is configured. * 3. Add a call to up_spiinitialize() in your low level application * initialization logic @@ -116,7 +147,7 @@ struct spi_dev_s; enum spi_dev_e; /**************************************************************************** - * Name: sam_spiselect + * Name: sam_spi[0|1]select * * Description: * PIO chip select pins may be programmed by the board specific logic in @@ -126,9 +157,9 @@ enum spi_dev_e; * a stub. * * An alternative way to program the PIO chip select pins is as a normal - * GPIO output. In that case, the automatic control of the CS pins is + * PIO output. In that case, the automatic control of the CS pins is * bypassed and this function must provide control of the chip select. - * NOTE: In this case, the GPIO output pin does *not* have to be the + * NOTE: In this case, the PIO output pin does *not* have to be the * same as the NPCS pin normal associated with the chip select number. * * Input Parameters: @@ -141,10 +172,15 @@ enum spi_dev_e; * ****************************************************************************/ -void sam_spiselect(enum spi_dev_e devid, bool selected); +#ifdef CONFIG_SAM34_SPI0 +void sam_spi0select(enum spi_dev_e devid, bool selected); +#endif +#ifdef CONFIG_SAM34_SPI1 +void sam_spi1select(enum spi_dev_e devid, bool selected); +#endif /**************************************************************************** - * Name: sam_spistatus + * Name: sam_spi[0|1]status * * Description: * Return status information associated with the SPI device. @@ -158,10 +194,15 @@ void sam_spiselect(enum spi_dev_e devid, bool selected); * ****************************************************************************/ -uint8_t sam_spistatus(FAR struct spi_dev_s *dev, enum spi_dev_e devid); +#ifdef CONFIG_SAM34_SPI0 +uint8_t sam_spi0status(FAR struct spi_dev_s *dev, enum spi_dev_e devid); +#endif +#ifdef CONFIG_SAM34_SPI1 +uint8_t sam_spi1status(FAR struct spi_dev_s *dev, enum spi_dev_e devid); +#endif /**************************************************************************** - * Name: sam_spicmddata + * Name: sam_spi[0|1]cmddata * * Description: * Some SPI devices require an additional control to determine if the SPI @@ -172,7 +213,7 @@ uint8_t sam_spistatus(FAR struct spi_dev_s *dev, enum spi_dev_e devid); * may be configured to use 9-bit data transfers with the 9th bit * indicating command or data. That same hardware may be configurable, * instead, to use 8-bit data but to require an additional, board- - * specific GPIO control to distinguish command and data. This function + * specific PIO control to distinguish command and data. This function * would be needed in that latter case. * * Input Parameters: @@ -185,7 +226,12 @@ uint8_t sam_spistatus(FAR struct spi_dev_s *dev, enum spi_dev_e devid); ****************************************************************************/ #ifdef CONFIG_SPI_CMDDATA -int sam_spicmddata(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool cmd); +#ifdef CONFIG_SAM34_SPI0 +int sam_spi0cmddata(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool cmd); +#endif +#ifdef CONFIG_SAM34_SPI1 +int sam_spi1cmddata(FAR struct spi_dev_s *dev, enum spi_dev_e devid, bool cmd); +#endif #endif #endif /* CONFIG_SAM34_SPI0 */ |