Add support for the TI PGA11x amplifier/multiplexer

git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@4977 7fd9a85b-ad96-42d3-883c-3090e2eb8679

1 files changed, 292 insertions, 0 deletions

diff --git a/nuttx/include/nuttx/input/pga11x.h b/nuttx/include/nuttx/input/pga11x.h
new file mode 100644
index 0000000000..f60d7830d5
--- /dev/null
+++ b/nuttx/include/nuttx/input/pga11x.h
@@ -0,0 +1,292 @@
+/****************************************************************************
+ * include/nuttx/input/pga11x.h
+ *
+ *   Copyright (C) 2012 Gregory Nutt. All rights reserved.
+ *   Authors: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * References:
+ *   "PGA112, PGA113, PGA116, PGA117: Zerø-Drift PROGRAMMABLE GAIN AMPLIFIER
+ *   with MUX", SBOS424B, March 2008, Revised September 2008, Texas
+ *   Instruments Incorporated"
+ *
+ * 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 __INCLUDE_NUTTX_INPUT_PGA11X_H
+#define __INCLUDE_NUTTX_INPUT_PGA11X_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <nuttx/spi.h>
+
+#if defined(CONFIG_INPUT) && defined(CONFIG_INPUT_PGA11X)
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+/* Configuration ************************************************************/
+/* Prerequisites:  CONFIG_INPUT=y
+ *
+ * CONFIG_INPUT_PGA11X
+ *   Enables support for the PGA11X driver (Needs CONFIG_INPUT)
+ * CONFIG_PGA11X_SPIFREQUENCY
+ *   SPI frequency.  Default 1MHz
+ * CONFIG_PGA11X_DAISYCHAIN
+ *   Use two PGA116/7's in Daisy Chain commands.
+ * CONFIG_PGA11X_SPIMODE
+ *   SPI Mode.  The specification says that the device operates in Mode 0 or
+ *   Mode 3.  But sometimes you need to tinker with this to get things to
+ *   work correctly. Default:  Mode 0
+ * CONFIG_PGA11X_MULTIPLE
+ *   Can be defined to support multiple PGA11X devices on board.  Each
+ *   device will require a customized SPI interface to distinguish them
+ *   When SPI_SELECT is called with devid=SPIDEV_MUX.
+ *
+ * Other settings that effect the driver:  CONFIG_SPI_OWNBUS, CONFIG_DEBUG_SPI.
+ */
+
+#ifndef CONFIG_PGA11X_SPIFREQUENCY
+#  define CONFIG_PGA11X_SPIFREQUENCY 1000000
+#endif
+
+#ifndef CONFIG_PGA11X_SPIMODE
+#  define CONFIG_PGA11X_SPIMODE SPIDEV_MODE0
+#endif
+
+/* PGA11x Commands **********************************************************/
+/* Write command Gain Selection Bits (PGA112/PGA113)
+ *
+ * the PGA112 and PGA116 provide binary gain selections (1, 2, 4, 8, 16, 32,
+ * 64, 128); the PGA113 and PGA117 provide scope gain selections (1, 2, 5, 10,
+ * 20, 50, 100, 200).
+ */
+
+#define PGA11X_GAIN_1          (0) /* Gain=1:   Scope Gain=1 */
+#define PGA11X_GAIN_2          (1) /* Gain=2:   Scope Gain=2 */
+#define PGA11X_GAIN_4          (2) /* Gain=4:   Scope Gain=5 */
+#define PGA11X_GAIN_5          (2) /* Gain=4:   Scope Gain=5 */
+#define PGA11X_GAIN_8          (3) /* Gain=8:   Scope Gain=10 */
+#define PGA11X_GAIN_10         (3) /* Gain=8:   Scope Gain=10 */
+#define PGA11X_GAIN_16         (4) /* Gain=16:  Scope Gain=20 */
+#define PGA11X_GAIN_20         (4) /* Gain=16:  Scope Gain=20 */
+#define PGA11X_GAIN_32         (5) /* Gain=32:  Scope Gain=50 */
+#define PGA11X_GAIN_50         (5) /* Gain=32:  Scope Gain=50 */
+#define PGA11X_GAIN_64         (6) /* Gain=64:  Scope Gain=100 */
+#define PGA11X_GAIN_100        (6) /* Gain=64:  Scope Gain=100 */
+#define PGA11X_GAIN_128        (7) /* Gain=128: Scope Gain=200 */
+#define PGA11X_GAIN_200        (7) /* Gain=128: Scope Gain=200 */
+
+/* Write command Mux Channel Selection Bits
+ *
+ * The PGA112/PGA113 have a two-channel input MUX; the PGA116/PGA117 have a
+ * 10-channel input MUX.
+ */
+
+#define PGA11X_CHAN_VCAL       (0) /* VCAL/CH0 */
+#define PGA11X_CHAN_CH0        (0) /* VCAL/CH0 */
+#define PGA11X_CHAN_CH1        (1) /* CH1 */
+#define PGA11X_CHAN_CH2        (2) /* CH2 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH3        (3) /* CH3 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH4        (4) /* CH4 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH5        (5) /* CH5 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH6        (6) /* CH6 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH7        (7) /* CH7 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH8        (8) /* CH8 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CH9        (9) /* CH9 (PGA116/PGA117 only) */
+#define PGA11X_CHAN_CAL1       (12) /* CAL1: connects to GND */
+#define PGA11X_CHAN_CAL2       (13) /* CAL2: connects to 0.9VCAL */
+#define PGA11X_CHAN_CAL3       (14) /* CAL3: connects to 0.1VCAL */
+#define PGA11X_CHAN_CAL4       (15) /* CAL4: connects to VREF */
+
+/* These macros may be used to decode the value returned by pga11x_read() */
+
+
+#define PGA11X_GAIN_SHIFT        (4)      /* B*/
+#define PGA11X_GAIN_MASK         (15 << PGA11X_GAIN_SHIFT)
+
+/* Write command Mux Channel Selection Bits
+ *
+ * The PGA112/PGA113 have a two-channel input MUX; the PGA116/PGA117 have a
+ * 10-channel input MUX.
+ */
+
+#ifndef CONFIG_PGA11X_DAISYCHAIN
+/* Bits 0-3: Channel Selection Bits
+ * Bits 4-7: Gain Selection Bits
+ */
+
+#  define PGA11X_CHAN(value)     ((uint16_t)value & 0x000f)
+#  define PGA11X_GAIN(value)     (((uint16_t)value >> 4) & 0x000f)
+
+#else
+/* Bits 0-3:   U1 Channel Selection Bits
+ * Bits 4-7:   U1 Gain Selection Bits
+ * Bits 16-19: U2 Channel Selection Bits
+ * Bits 20-23: U2 Gain Selection Bits
+ */
+
+#  define PGA11X_U1_CHAN(value)  ((uint32_t)value & 0x0000000f)
+#  define PGA11X_U1_GAIN(value)  (((uint32_t)value >> 4) & 0x0000000f)
+#  define PGA11X_U2_CHAN(value)  (((uint32_t)value >> 16) & 0x0000000f)
+#  define PGA11X_U2_GAIN(value)  (((uint32_t)value >> 20) & 0x0000000f)
+#endif
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
+/* Handle used to reference the particular PGA11X instance */
+
+typedef FAR void *PGA11X_HANDLE;
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Name: pga11x_initialize
+ *
+ * Description:
+ *   Initialize the PGA117 amplifier/multiplexer.
+ *
+ * Input Parameters:
+ *   spi - An SPI "bottom half" device driver instance
+ *
+ * Returned Value:
+ *   On success, a non-NULL opaque handle is returned; a NULL is returned
+ *   on any failure.  This handle may be used with the other PGA117 interface
+ *   functions to control the multiplexer
+ *
+ ****************************************************************************/
+
+EXTERN PGA11X_HANDLE pga11x_initialize(FAR struct spi_dev_s *spi);
+
+/****************************************************************************
+ * Name: pga11x_select
+ *
+ * Description:
+ *   Select an input channel and gain.
+ *
+ * Input Parameters:
+ *   spi - An SPI "bottom half" device driver instance
+ *   channel - See the PGA11X_CHAN_* definitions above
+ *   gain    - See the PGA11X_GAIN_* definitions above
+ *
+ * Returned Value:
+ *   Zero on sucess; a negated errno value on failure.
+ *
+ ****************************************************************************/
+
+EXTERN int pga11x_select(PGA11X_HANDLE handle, uint8_t channel, uint8_t gain);
+
+/****************************************************************************
+ * Name: pga11x_read
+ *
+ * Description:
+ *   Read from the PGA117 amplifier/multiplexer.
+ *
+ * Input Parameters:
+ *   spi - An SPI "bottom half" device driver instance
+ *
+ * Returned Value:
+ *   16-bit value read from the device (32-bits in daisy chain mode)
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_PGA11X_DAISYCHAIN
+EXTERN uint32_t pga11x_read(PGA11X_HANDLE handle);
+#else
+EXTERN uint16_t pga11x_read(PGA11X_HANDLE handle);
+#endif
+
+/****************************************************************************
+ * Name: pga11x_noop
+ *
+ * Description:
+ *   Perform PGA11x no-operation.
+ *
+ * Input Parameters:
+ *   spi - An SPI "bottom half" device driver instance
+ *
+ * Returned Value:
+ *   Zero on sucess; a negated errno value on failure.
+ *
+ ****************************************************************************/
+
+EXTERN int pga11x_noop(PGA11X_HANDLE handle);
+
+/****************************************************************************
+ * Name: pga11x_shutdown
+ *
+ * Description:
+ *   Put the PGA11x in shutdown down mode.
+ *
+ * Input Parameters:
+ *   spi - An SPI "bottom half" device driver instance
+ *
+ * Returned Value:
+ *   Zero on sucess; a negated errno value on failure.
+ *
+ ****************************************************************************/
+
+EXTERN int pga11x_shutdown(PGA11X_HANDLE handle);
+
+/****************************************************************************
+ * Name: pga11x_enable
+ *
+ * Description:
+ *   Take the PGA11x out of shutdown down mode.
+ *
+ * Input Parameters:
+ *   spi - An SPI "bottom half" device driver instance
+ *
+ * Returned Value:
+ *   Zero on sucess; a negated errno value on failure.
+ *
+ ****************************************************************************/
+
+EXTERN int pga11x_enable(PGA11X_HANDLE handle);
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CONFIG_INPUT && CONFIG_INPUT_PGA11X */
+#endif /* __INCLUDE_NUTTX_INPUT_PGA11X_H */