drivers/spi/mxs_spi.c

   1 /*
   2  * Freescale i.MX28 SPI driver
   3  *
   4  * Copyright (C) 2011 Marek Vasut <marek.vasut@gmail.com>
   5  * on behalf of DENX Software Engineering GmbH
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of
  10  * the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  20  * MA 02111-1307 USA
  21  *
  22  * NOTE: This driver only supports the SPI-controller chipselects,
  23  *       GPIO driven chipselects are not supported.
  24  */
  25
  26 #include <common.h>
  27 #include <malloc.h>
  28 #include <spi.h>
  29 #include <asm/errno.h>
  30 #include <asm/io.h>
  31 #include <asm/arch/clock.h>
  32 #include <asm/arch/imx-regs.h>
  33 #include <asm/arch/sys_proto.h>
  34
  35 #define MXS_SPI_MAX_TIMEOUT     1000000
  36 #define MXS_SPI_PORT_OFFSET     0x2000
  37
  38 struct mxs_spi_slave {
  39         struct spi_slave        slave;
  40         uint32_t                max_khz;
  41         uint32_t                mode;
  42         struct mx28_ssp_regs    *regs;
  43 };
  44
  45 static inline struct mxs_spi_slave *to_mxs_slave(struct spi_slave *slave)
  46 {
  47         return container_of(slave, struct mxs_spi_slave, slave);
  48 }
  49
  50 void spi_init(void)
  51 {
  52 }
  53
  54 int spi_cs_is_valid(unsigned int bus, unsigned int cs)
  55 {
  56         /* MXS SPI: 4 ports and 3 chip selects maximum */
  57         if (bus > 3 || cs > 2)
  58                 return 0;
  59         else
  60                 return 1;
  61 }
  62
  63 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
  64                                   unsigned int max_hz, unsigned int mode)
  65 {
  66         struct mxs_spi_slave *mxs_slave;
  67         uint32_t addr;
  68
  69         if (!spi_cs_is_valid(bus, cs)) {
  70                 printf("mxs_spi: invalid bus %d / chip select %d\n", bus, cs);
  71                 return NULL;
  72         }
  73
  74         mxs_slave = malloc(sizeof(struct mxs_spi_slave));
  75         if (!mxs_slave)
  76                 return NULL;
  77
  78         addr = MXS_SSP0_BASE + (bus * MXS_SPI_PORT_OFFSET);
  79
  80         mxs_slave->slave.bus = bus;
  81         mxs_slave->slave.cs = cs;
  82         mxs_slave->max_khz = max_hz / 1000;
  83         mxs_slave->mode = mode;
  84         mxs_slave->regs = (struct mx28_ssp_regs *)addr;
  85
  86         return &mxs_slave->slave;
  87 }
  88
  89 void spi_free_slave(struct spi_slave *slave)
  90 {
  91         struct mxs_spi_slave *mxs_slave = to_mxs_slave(slave);
  92         free(mxs_slave);
  93 }
  94
  95 int spi_claim_bus(struct spi_slave *slave)
  96 {
  97         struct mxs_spi_slave *mxs_slave = to_mxs_slave(slave);
  98         struct mx28_ssp_regs *ssp_regs = mxs_slave->regs;
  99         uint32_t reg = 0;
 100
 101         mx28_reset_block(&ssp_regs->hw_ssp_ctrl0_reg);
 102
 103         writel(SSP_CTRL0_BUS_WIDTH_ONE_BIT, &ssp_regs->hw_ssp_ctrl0);
 104
 105         reg = SSP_CTRL1_SSP_MODE_SPI | SSP_CTRL1_WORD_LENGTH_EIGHT_BITS;
 106         reg |= (mxs_slave->mode & SPI_CPOL) ? SSP_CTRL1_POLARITY : 0;
 107         reg |= (mxs_slave->mode & SPI_CPHA) ? SSP_CTRL1_PHASE : 0;
 108         writel(reg, &ssp_regs->hw_ssp_ctrl1);
 109
 110         writel(0, &ssp_regs->hw_ssp_cmd0);
 111
 112         mx28_set_ssp_busclock(slave->bus, mxs_slave->max_khz);
 113
 114         return 0;
 115 }
 116
 117 void spi_release_bus(struct spi_slave *slave)
 118 {
 119 }
 120
 121 static void mxs_spi_start_xfer(struct mx28_ssp_regs *ssp_regs)
 122 {
 123         writel(SSP_CTRL0_LOCK_CS, &ssp_regs->hw_ssp_ctrl0_set);
 124         writel(SSP_CTRL0_IGNORE_CRC, &ssp_regs->hw_ssp_ctrl0_clr);
 125 }
 126
 127 static void mxs_spi_end_xfer(struct mx28_ssp_regs *ssp_regs)
 128 {
 129         writel(SSP_CTRL0_LOCK_CS, &ssp_regs->hw_ssp_ctrl0_clr);
 130         writel(SSP_CTRL0_IGNORE_CRC, &ssp_regs->hw_ssp_ctrl0_set);
 131 }
 132
 133 int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
 134                 const void *dout, void *din, unsigned long flags)
 135 {
 136         struct mxs_spi_slave *mxs_slave = to_mxs_slave(slave);
 137         struct mx28_ssp_regs *ssp_regs = mxs_slave->regs;
 138         int len = bitlen / 8;
 139         const char *tx = dout;
 140         char *rx = din;
 141         char dummy;
 142
 143         if (bitlen == 0) {
 144                 if (flags & SPI_XFER_END) {
 145                         rx = &dummy;
 146                         len = 1;
 147                 } else
 148                         return 0;
 149         }
 150
 151         if (!rx && !tx)
 152                 return 0;
 153
 154         if (flags & SPI_XFER_BEGIN)
 155                 mxs_spi_start_xfer(ssp_regs);
 156
 157         while (len--) {
 158                 /* We transfer 1 byte */
 159                 writel(1, &ssp_regs->hw_ssp_xfer_size);
 160
 161                 if ((flags & SPI_XFER_END) && !len)
 162                         mxs_spi_end_xfer(ssp_regs);
 163
 164                 if (tx)
 165                         writel(SSP_CTRL0_READ, &ssp_regs->hw_ssp_ctrl0_clr);
 166                 else
 167                         writel(SSP_CTRL0_READ, &ssp_regs->hw_ssp_ctrl0_set);
 168
 169                 writel(SSP_CTRL0_RUN, &ssp_regs->hw_ssp_ctrl0_set);
 170
 171                 if (mx28_wait_mask_set(&ssp_regs->hw_ssp_ctrl0_reg,
 172                         SSP_CTRL0_RUN, MXS_SPI_MAX_TIMEOUT)) {
 173                         printf("MXS SPI: Timeout waiting for start\n");
 174                         return -ETIMEDOUT;
 175                 }
 176
 177                 if (tx)
 178                         writel(*tx++, &ssp_regs->hw_ssp_data);
 179
 180                 writel(SSP_CTRL0_DATA_XFER, &ssp_regs->hw_ssp_ctrl0_set);
 181
 182                 if (rx) {
 183                         if (mx28_wait_mask_clr(&ssp_regs->hw_ssp_status_reg,
 184                                 SSP_STATUS_FIFO_EMPTY, MXS_SPI_MAX_TIMEOUT)) {
 185                                 printf("MXS SPI: Timeout waiting for data\n");
 186                                 return -ETIMEDOUT;
 187                         }
 188
 189                         *rx = readl(&ssp_regs->hw_ssp_data);
 190                         rx++;
 191                 }
 192
 193                 if (mx28_wait_mask_clr(&ssp_regs->hw_ssp_ctrl0_reg,
 194                         SSP_CTRL0_RUN, MXS_SPI_MAX_TIMEOUT)) {
 195                         printf("MXS SPI: Timeout waiting for finish\n");
 196                         return -ETIMEDOUT;
 197                 }
 198         }
 199
 200         return 0;
 201 }