drivers/spi/fsl_espi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * eSPI controller driver.
   4  *
   5  * Copyright 2010-2011 Freescale Semiconductor, Inc.
   6  * Author: Mingkai Hu (Mingkai.hu@freescale.com)
   7  */
   8
   9 #include <common.h>
  10 #include <log.h>
  11 #include <linux/bitops.h>
  12 #include <linux/delay.h>
  13
  14 #include <malloc.h>
  15 #include <spi.h>
  16 #include <asm/immap_85xx.h>
  17
  18 struct fsl_spi_slave {
  19         struct spi_slave slave;
  20         ccsr_espi_t     *espi;
  21         unsigned int    div16;
  22         unsigned int    pm;
  23         int             tx_timeout;
  24         unsigned int    mode;
  25         size_t          cmd_len;
  26         u8              cmd_buf[16];
  27         size_t          data_len;
  28         unsigned int    max_transfer_length;
  29 };
  30
  31 #define to_fsl_spi_slave(s) container_of(s, struct fsl_spi_slave, slave)
  32 #define US_PER_SECOND           1000000UL
  33
  34 #define ESPI_MAX_CS_NUM         4
  35 #define ESPI_FIFO_WIDTH_BIT     32
  36
  37 #define ESPI_EV_RNE             BIT(9)
  38 #define ESPI_EV_TNF             BIT(8)
  39 #define ESPI_EV_DON             BIT(14)
  40 #define ESPI_EV_TXE             BIT(15)
  41 #define ESPI_EV_RFCNT_SHIFT     24
  42 #define ESPI_EV_RFCNT_MASK      (0x3f << ESPI_EV_RFCNT_SHIFT)
  43
  44 #define ESPI_MODE_EN            BIT(31) /* Enable interface */
  45 #define ESPI_MODE_TXTHR(x)      ((x) << 8)      /* Tx FIFO threshold */
  46 #define ESPI_MODE_RXTHR(x)      ((x) << 0)      /* Rx FIFO threshold */
  47
  48 #define ESPI_COM_CS(x)          ((x) << 30)
  49 #define ESPI_COM_TRANLEN(x)     ((x) << 0)
  50
  51 #define ESPI_CSMODE_CI_INACTIVEHIGH     BIT(31)
  52 #define ESPI_CSMODE_CP_BEGIN_EDGCLK     BIT(30)
  53 #define ESPI_CSMODE_REV_MSB_FIRST       BIT(29)
  54 #define ESPI_CSMODE_DIV16               BIT(28)
  55 #define ESPI_CSMODE_PM(x)               ((x) << 24)
  56 #define ESPI_CSMODE_POL_ASSERTED_LOW    BIT(20)
  57 #define ESPI_CSMODE_LEN(x)              ((x) << 16)
  58 #define ESPI_CSMODE_CSBEF(x)            ((x) << 12)
  59 #define ESPI_CSMODE_CSAFT(x)            ((x) << 8)
  60 #define ESPI_CSMODE_CSCG(x)             ((x) << 3)
  61
  62 #define ESPI_CSMODE_INIT_VAL (ESPI_CSMODE_POL_ASSERTED_LOW | \
  63                 ESPI_CSMODE_CSBEF(0) | ESPI_CSMODE_CSAFT(0) | \
  64                 ESPI_CSMODE_CSCG(1))
  65
  66 #define ESPI_MAX_DATA_TRANSFER_LEN 0xFFF0
  67
  68 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
  69                 unsigned int max_hz, unsigned int mode)
  70 {
  71         struct fsl_spi_slave *fsl;
  72         sys_info_t sysinfo;
  73         unsigned long spibrg = 0;
  74         unsigned long spi_freq = 0;
  75         unsigned char pm = 0;
  76
  77         if (!spi_cs_is_valid(bus, cs))
  78                 return NULL;
  79
  80         fsl = spi_alloc_slave(struct fsl_spi_slave, bus, cs);
  81         if (!fsl)
  82                 return NULL;
  83
  84         fsl->espi = (void *)(CONFIG_SYS_MPC85xx_ESPI_ADDR);
  85         fsl->mode = mode;
  86         fsl->max_transfer_length = ESPI_MAX_DATA_TRANSFER_LEN;
  87
  88         /* Set eSPI BRG clock source */
  89         get_sys_info(&sysinfo);
  90         spibrg = sysinfo.freq_systembus / 2;
  91         fsl->div16 = 0;
  92         if ((spibrg / max_hz) > 32) {
  93                 fsl->div16 = ESPI_CSMODE_DIV16;
  94                 pm = spibrg / (max_hz * 16 * 2);
  95                 if (pm > 16) {
  96                         pm = 16;
  97                         debug("Requested speed is too low: %d Hz, %ld Hz "
  98                                 "is used.\n", max_hz, spibrg / (32 * 16));
  99                 }
 100         } else
 101                 pm = spibrg / (max_hz * 2);
 102         if (pm)
 103                 pm--;
 104         fsl->pm = pm;
 105
 106         if (fsl->div16)
 107                 spi_freq = spibrg / ((pm + 1) * 2 * 16);
 108         else
 109                 spi_freq = spibrg / ((pm + 1) * 2);
 110
 111         /* set tx_timeout to 10 times of one espi FIFO entry go out */
 112         fsl->tx_timeout = DIV_ROUND_UP((US_PER_SECOND * ESPI_FIFO_WIDTH_BIT
 113                                 * 10), spi_freq);
 114
 115         return &fsl->slave;
 116 }
 117
 118 void spi_free_slave(struct spi_slave *slave)
 119 {
 120         struct fsl_spi_slave *fsl = to_fsl_spi_slave(slave);
 121         free(fsl);
 122 }
 123
 124 int spi_claim_bus(struct spi_slave *slave)
 125 {
 126         struct fsl_spi_slave *fsl = to_fsl_spi_slave(slave);
 127         ccsr_espi_t *espi = fsl->espi;
 128         unsigned char pm = fsl->pm;
 129         unsigned int cs = slave->cs;
 130         unsigned int mode =  fsl->mode;
 131         unsigned int div16 = fsl->div16;
 132         int i;
 133
 134         debug("%s: bus:%i cs:%i\n", __func__, slave->bus, cs);
 135
 136         /* Enable eSPI interface */
 137         out_be32(&espi->mode, ESPI_MODE_RXTHR(3)
 138                         | ESPI_MODE_TXTHR(4) | ESPI_MODE_EN);
 139
 140         out_be32(&espi->event, 0xffffffff); /* Clear all eSPI events */
 141         out_be32(&espi->mask, 0x00000000); /* Mask  all eSPI interrupts */
 142
 143         /* Init CS mode interface */
 144         for (i = 0; i < ESPI_MAX_CS_NUM; i++)
 145                 out_be32(&espi->csmode[i], ESPI_CSMODE_INIT_VAL);
 146
 147         out_be32(&espi->csmode[cs], in_be32(&espi->csmode[cs]) &
 148                 ~(ESPI_CSMODE_PM(0xF) | ESPI_CSMODE_DIV16
 149                 | ESPI_CSMODE_CI_INACTIVEHIGH | ESPI_CSMODE_CP_BEGIN_EDGCLK
 150                 | ESPI_CSMODE_REV_MSB_FIRST | ESPI_CSMODE_LEN(0xF)));
 151
 152         /* Set eSPI BRG clock source */
 153         out_be32(&espi->csmode[cs], in_be32(&espi->csmode[cs])
 154                 | ESPI_CSMODE_PM(pm) | div16);
 155
 156         /* Set eSPI mode */
 157         if (mode & SPI_CPHA)
 158                 out_be32(&espi->csmode[cs], in_be32(&espi->csmode[cs])
 159                         | ESPI_CSMODE_CP_BEGIN_EDGCLK);
 160         if (mode & SPI_CPOL)
 161                 out_be32(&espi->csmode[cs], in_be32(&espi->csmode[cs])
 162                         | ESPI_CSMODE_CI_INACTIVEHIGH);
 163
 164         /* Character bit order: msb first */
 165         out_be32(&espi->csmode[cs], in_be32(&espi->csmode[cs])
 166                 | ESPI_CSMODE_REV_MSB_FIRST);
 167
 168         /* Character length in bits, between 0x3~0xf, i.e. 4bits~16bits */
 169         out_be32(&espi->csmode[cs], in_be32(&espi->csmode[cs])
 170                 | ESPI_CSMODE_LEN(7));
 171
 172         return 0;
 173 }
 174
 175 void spi_release_bus(struct spi_slave *slave)
 176 {
 177
 178 }
 179
 180 static void fsl_espi_tx(struct fsl_spi_slave *fsl, const void *dout)
 181 {
 182         ccsr_espi_t *espi = fsl->espi;
 183         unsigned int tmpdout, event;
 184         int tmp_tx_timeout;
 185
 186         if (dout)
 187                 tmpdout = *(u32 *)dout;
 188         else
 189                 tmpdout = 0;
 190
 191         out_be32(&espi->tx, tmpdout);
 192         out_be32(&espi->event, ESPI_EV_TNF);
 193         debug("***spi_xfer:...%08x written\n", tmpdout);
 194
 195         tmp_tx_timeout = fsl->tx_timeout;
 196         /* Wait for eSPI transmit to go out */
 197         while (tmp_tx_timeout--) {
 198                 event = in_be32(&espi->event);
 199                 if (event & ESPI_EV_DON || event & ESPI_EV_TXE) {
 200                         out_be32(&espi->event, ESPI_EV_TXE);
 201                         break;
 202                 }
 203                 udelay(1);
 204         }
 205
 206         if (tmp_tx_timeout < 0)
 207                 debug("***spi_xfer:...Tx timeout! event = %08x\n", event);
 208 }
 209
 210 static int fsl_espi_rx(struct fsl_spi_slave *fsl, void *din, unsigned int bytes)
 211 {
 212         ccsr_espi_t *espi = fsl->espi;
 213         unsigned int tmpdin, rx_times;
 214         unsigned char *buf, *p_cursor;
 215
 216         if (bytes <= 0)
 217                 return 0;
 218
 219         rx_times = DIV_ROUND_UP(bytes, 4);
 220         buf = (unsigned char *)malloc(4 * rx_times);
 221         if (!buf) {
 222                 debug("SF: Failed to malloc memory.\n");
 223                 return -1;
 224         }
 225         p_cursor = buf;
 226         while (rx_times--) {
 227                 tmpdin = in_be32(&espi->rx);
 228                 debug("***spi_xfer:...%08x readed\n", tmpdin);
 229                 *(u32 *)p_cursor = tmpdin;
 230                 p_cursor += 4;
 231         }
 232
 233         if (din)
 234                 memcpy(din, buf, bytes);
 235
 236         free(buf);
 237         out_be32(&espi->event, ESPI_EV_RNE);
 238
 239         return bytes;
 240 }
 241
 242 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *data_out,
 243                 void *data_in, unsigned long flags)
 244 {
 245         struct fsl_spi_slave *fsl = to_fsl_spi_slave(slave);
 246         ccsr_espi_t *espi = fsl->espi;
 247         unsigned int event, rx_bytes;
 248         const void *dout = NULL;
 249         void *din = NULL;
 250         int len = 0;
 251         int num_blks, num_chunks, max_tran_len, tran_len;
 252         int num_bytes;
 253         unsigned char *buffer = NULL;
 254         size_t buf_len;
 255         u8 *cmd_buf = fsl->cmd_buf;
 256         size_t cmd_len = fsl->cmd_len;
 257         size_t data_len = bitlen / 8;
 258         size_t rx_offset = 0;
 259         int rf_cnt;
 260
 261         max_tran_len = fsl->max_transfer_length;
 262         switch (flags) {
 263         case SPI_XFER_BEGIN:
 264                 cmd_len = fsl->cmd_len = data_len;
 265                 memcpy(cmd_buf, data_out, cmd_len);
 266                 return 0;
 267         case 0:
 268         case SPI_XFER_END:
 269                 if (bitlen == 0) {
 270                         spi_cs_deactivate(slave);
 271                         return 0;
 272                 }
 273                 buf_len = 2 * cmd_len + min(data_len, (size_t)max_tran_len);
 274                 len = cmd_len + data_len;
 275                 rx_offset = cmd_len;
 276                 buffer = (unsigned char *)malloc(buf_len);
 277                 if (!buffer) {
 278                         debug("SF: Failed to malloc memory.\n");
 279                         return 1;
 280                 }
 281                 memcpy(buffer, cmd_buf, cmd_len);
 282                 if (data_in == NULL)
 283                         memcpy(buffer + cmd_len, data_out, data_len);
 284                 break;
 285         case SPI_XFER_BEGIN | SPI_XFER_END:
 286                 len = data_len;
 287                 buffer = (unsigned char *)malloc(len * 2);
 288                 if (!buffer) {
 289                         debug("SF: Failed to malloc memory.\n");
 290                         return 1;
 291                 }
 292                 memcpy(buffer, data_out, len);
 293                 rx_offset = len;
 294                 cmd_len = 0;
 295                 break;
 296         }
 297
 298         debug("spi_xfer: data_out %08X(%p) data_in %08X(%p) len %u\n",
 299               *(uint *)data_out, data_out, *(uint *)data_in, data_in, len);
 300
 301         num_chunks = DIV_ROUND_UP(data_len, max_tran_len);
 302         while (num_chunks--) {
 303                 if (data_in)
 304                         din = buffer + rx_offset;
 305                 dout = buffer;
 306                 tran_len = min(data_len, (size_t)max_tran_len);
 307                 num_blks = DIV_ROUND_UP(tran_len + cmd_len, 4);
 308                 num_bytes = (tran_len + cmd_len) % 4;
 309                 fsl->data_len = tran_len + cmd_len;
 310                 spi_cs_activate(slave);
 311
 312                 /* Clear all eSPI events */
 313                 out_be32(&espi->event , 0xffffffff);
 314                 /* handle data in 32-bit chunks */
 315                 while (num_blks) {
 316                         event = in_be32(&espi->event);
 317                         if (event & ESPI_EV_TNF) {
 318                                 fsl_espi_tx(fsl, dout);
 319                                 /* Set up the next iteration */
 320                                 if (len > 4) {
 321                                         len -= 4;
 322                                         dout += 4;
 323                                 }
 324                         }
 325
 326                         event = in_be32(&espi->event);
 327                         if (event & ESPI_EV_RNE) {
 328                                 rf_cnt = ((event & ESPI_EV_RFCNT_MASK)
 329                                                 >> ESPI_EV_RFCNT_SHIFT);
 330                                 if (rf_cnt >= 4)
 331                                         rx_bytes = 4;
 332                                 else if (num_blks == 1 && rf_cnt == num_bytes)
 333                                         rx_bytes = num_bytes;
 334                                 else
 335                                         continue;
 336                                 if (fsl_espi_rx(fsl, din, rx_bytes)
 337                                                 == rx_bytes) {
 338                                         num_blks--;
 339                                         if (din)
 340                                                 din = (unsigned char *)din
 341                                                         + rx_bytes;
 342                                 }
 343                         }
 344                 }
 345                 if (data_in) {
 346                         memcpy(data_in, buffer + 2 * cmd_len, tran_len);
 347                         if (*buffer == 0x0b) {
 348                                 data_in += tran_len;
 349                                 data_len -= tran_len;
 350                                 *(int *)buffer += tran_len;
 351                         }
 352                 }
 353                 spi_cs_deactivate(slave);
 354         }
 355
 356         free(buffer);
 357         return 0;
 358 }
 359
 360 int spi_cs_is_valid(unsigned int bus, unsigned int cs)
 361 {
 362         return bus == 0 && cs < ESPI_MAX_CS_NUM;
 363 }
 364
 365 void spi_cs_activate(struct spi_slave *slave)
 366 {
 367         struct fsl_spi_slave *fsl = to_fsl_spi_slave(slave);
 368         ccsr_espi_t *espi = fsl->espi;
 369         unsigned int com = 0;
 370         size_t data_len = fsl->data_len;
 371
 372         com &= ~(ESPI_COM_CS(0x3) | ESPI_COM_TRANLEN(0xFFFF));
 373         com |= ESPI_COM_CS(slave->cs);
 374         com |= ESPI_COM_TRANLEN(data_len - 1);
 375         out_be32(&espi->com, com);
 376 }
 377
 378 void spi_cs_deactivate(struct spi_slave *slave)
 379 {
 380         struct fsl_spi_slave *fsl = to_fsl_spi_slave(slave);
 381         ccsr_espi_t *espi = fsl->espi;
 382
 383         /* clear the RXCNT and TXCNT */
 384         out_be32(&espi->mode, in_be32(&espi->mode) & (~ESPI_MODE_EN));
 385         out_be32(&espi->mode, in_be32(&espi->mode) | ESPI_MODE_EN);
 386 }