wiringPi/wiringPiSPI.c

   1 /*
   2  * wiringPiSPI.c:
   3  *      Simplified SPI access routines
   4  *      Copyright (c) 2012-2015 Gordon Henderson
   5  ***********************************************************************
   6  * This file is part of wiringPi:
   7  *      https://projects.drogon.net/raspberry-pi/wiringpi/
   8  *
   9  *    wiringPi is free software: you can redistribute it and/or modify
  10  *    it under the terms of the GNU Lesser General Public License as
  11  *    published by the Free Software Foundation, either version 3 of the
  12  *    License, or (at your option) any later version.
  13  *
  14  *    wiringPi is distributed in the hope that it will be useful,
  15  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *    GNU Lesser General Public License for more details.
  18  *
  19  *    You should have received a copy of the GNU Lesser General Public
  20  *    License along with wiringPi.
  21  *    If not, see <http://www.gnu.org/licenses/>.
  22  ***********************************************************************
  23  */
  24
  25
  26 #include <stdint.h>
  27 #include <fcntl.h>
  28 #include <errno.h>
  29 #include <string.h>
  30 #include <sys/ioctl.h>
  31 #include <linux/spi/spidev.h>
  32
  33 #include "wiringPi.h"
  34
  35 #include "wiringPiSPI.h"
  36
  37
  38 // The SPI bus parameters
  39 //      Variables as they need to be passed as pointers later on
  40
  41 const static char       *spiDev0  = "/dev/spidev0.0" ;
  42 const static char       *spiDev1  = "/dev/spidev0.1" ;
  43 const static uint8_t     spiBPW   = 8 ;
  44 const static uint16_t    spiDelay = 0 ;
  45
  46 static uint32_t    spiSpeeds [2] ;
  47 static int         spiFds [2] ;
  48
  49
  50 /*
  51  * wiringPiSPIGetFd:
  52  *      Return the file-descriptor for the given channel
  53  *********************************************************************************
  54  */
  55
  56 int wiringPiSPIGetFd (int channel)
  57 {
  58   return spiFds [channel & 1] ;
  59 }
  60
  61
  62 /*
  63  * wiringPiSPIDataRW:
  64  *      Write and Read a block of data over the SPI bus.
  65  *      Note the data ia being read into the transmit buffer, so will
  66  *      overwrite it!
  67  *      This is also a full-duplex operation.
  68  *********************************************************************************
  69  */
  70
  71 int wiringPiSPIDataRW (int channel, unsigned char *data, int len)
  72 {
  73   struct spi_ioc_transfer spi ;
  74
  75   channel &= 1 ;
  76
  77 // Mentioned in spidev.h but not used in the original kernel documentation
  78 //      test program )-:
  79
  80   memset (&spi, 0, sizeof (spi)) ;
  81
  82   spi.tx_buf        = (unsigned long)data ;
  83   spi.rx_buf        = (unsigned long)data ;
  84   spi.len           = len ;
  85   spi.delay_usecs   = spiDelay ;
  86   spi.speed_hz      = spiSpeeds [channel] ;
  87   spi.bits_per_word = spiBPW ;
  88
  89   return ioctl (spiFds [channel], SPI_IOC_MESSAGE(1), &spi) ;
  90 }
  91
  92
  93 /*
  94  * wiringPiSPISetupMode:
  95  *      Open the SPI device, and set it up, with the mode, etc.
  96  *********************************************************************************
  97  */
  98
  99 int wiringPiSPISetupMode (int channel, int speed, int mode)
 100 {
 101   int fd ;
 102
 103   mode    &= 3 ;        // Mode is 0, 1, 2 or 3
 104   channel &= 1 ;        // Channel is 0 or 1
 105
 106   if ((fd = open (channel == 0 ? spiDev0 : spiDev1, O_RDWR)) < 0)
 107     return wiringPiFailure (WPI_ALMOST, "Unable to open SPI device: %s\n", strerror (errno)) ;
 108
 109   spiSpeeds [channel] = speed ;
 110   spiFds    [channel] = fd ;
 111
 112 // Set SPI parameters.
 113
 114   if (ioctl (fd, SPI_IOC_WR_MODE, &mode)            < 0)
 115     return wiringPiFailure (WPI_ALMOST, "SPI Mode Change failure: %s\n", strerror (errno)) ;
 116
 117   if (ioctl (fd, SPI_IOC_WR_BITS_PER_WORD, &spiBPW) < 0)
 118     return wiringPiFailure (WPI_ALMOST, "SPI BPW Change failure: %s\n", strerror (errno)) ;
 119
 120   if (ioctl (fd, SPI_IOC_WR_MAX_SPEED_HZ, &speed)   < 0)
 121     return wiringPiFailure (WPI_ALMOST, "SPI Speed Change failure: %s\n", strerror (errno)) ;
 122
 123   return fd ;
 124 }
 125
 126
 127 /*
 128  * wiringPiSPISetup:
 129  *      Open the SPI device, and set it up, etc. in the default MODE 0
 130  *********************************************************************************
 131  */
 132
 133 int wiringPiSPISetup (int channel, int speed)
 134 {
 135   return wiringPiSPISetupMode (channel, speed, 0) ;
 136 }