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