drivers/spi/spi-pxa2xx.c

   1 /*
   2  * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
   3  * Copyright (C) 2013, Intel Corporation
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  */
  15
  16 #include <linux/bitops.h>
  17 #include <linux/init.h>
  18 #include <linux/module.h>
  19 #include <linux/device.h>
  20 #include <linux/ioport.h>
  21 #include <linux/errno.h>
  22 #include <linux/err.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/kernel.h>
  25 #include <linux/pci.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/spi/pxa2xx_spi.h>
  28 #include <linux/spi/spi.h>
  29 #include <linux/delay.h>
  30 #include <linux/gpio.h>
  31 #include <linux/slab.h>
  32 #include <linux/clk.h>
  33 #include <linux/pm_runtime.h>
  34 #include <linux/acpi.h>
  35
  36 #include "spi-pxa2xx.h"
  37
  38 MODULE_AUTHOR("Stephen Street");
  39 MODULE_DESCRIPTION("PXA2xx SSP SPI Controller");
  40 MODULE_LICENSE("GPL");
  41 MODULE_ALIAS("platform:pxa2xx-spi");
  42
  43 #define TIMOUT_DFLT             1000
  44
  45 /*
  46  * for testing SSCR1 changes that require SSP restart, basically
  47  * everything except the service and interrupt enables, the pxa270 developer
  48  * manual says only SSCR1_SCFR, SSCR1_SPH, SSCR1_SPO need to be in this
  49  * list, but the PXA255 dev man says all bits without really meaning the
  50  * service and interrupt enables
  51  */
  52 #define SSCR1_CHANGE_MASK (SSCR1_TTELP | SSCR1_TTE | SSCR1_SCFR \
  53                                 | SSCR1_ECRA | SSCR1_ECRB | SSCR1_SCLKDIR \
  54                                 | SSCR1_SFRMDIR | SSCR1_RWOT | SSCR1_TRAIL \
  55                                 | SSCR1_IFS | SSCR1_STRF | SSCR1_EFWR \
  56                                 | SSCR1_RFT | SSCR1_TFT | SSCR1_MWDS \
  57                                 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
  58
  59 #define QUARK_X1000_SSCR1_CHANGE_MASK (QUARK_X1000_SSCR1_STRF   \
  60                                 | QUARK_X1000_SSCR1_EFWR        \
  61                                 | QUARK_X1000_SSCR1_RFT         \
  62                                 | QUARK_X1000_SSCR1_TFT         \
  63                                 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
  64
  65 #define LPSS_GENERAL_REG_RXTO_HOLDOFF_DISABLE   BIT(24)
  66 #define LPSS_CS_CONTROL_SW_MODE                 BIT(0)
  67 #define LPSS_CS_CONTROL_CS_HIGH                 BIT(1)
  68 #define LPSS_CAPS_CS_EN_SHIFT                   9
  69 #define LPSS_CAPS_CS_EN_MASK                    (0xf << LPSS_CAPS_CS_EN_SHIFT)
  70
  71 struct lpss_config {
  72         /* LPSS offset from drv_data->ioaddr */
  73         unsigned offset;
  74         /* Register offsets from drv_data->lpss_base or -1 */
  75         int reg_general;
  76         int reg_ssp;
  77         int reg_cs_ctrl;
  78         int reg_capabilities;
  79         /* FIFO thresholds */
  80         u32 rx_threshold;
  81         u32 tx_threshold_lo;
  82         u32 tx_threshold_hi;
  83         /* Chip select control */
  84         unsigned cs_sel_shift;
  85         unsigned cs_sel_mask;
  86         unsigned cs_num;
  87 };
  88
  89 /* Keep these sorted with enum pxa_ssp_type */
  90 static const struct lpss_config lpss_platforms[] = {
  91         {       /* LPSS_LPT_SSP */
  92                 .offset = 0x800,
  93                 .reg_general = 0x08,
  94                 .reg_ssp = 0x0c,
  95                 .reg_cs_ctrl = 0x18,
  96                 .reg_capabilities = -1,
  97                 .rx_threshold = 64,
  98                 .tx_threshold_lo = 160,
  99                 .tx_threshold_hi = 224,
 100         },
 101         {       /* LPSS_BYT_SSP */
 102                 .offset = 0x400,
 103                 .reg_general = 0x08,
 104                 .reg_ssp = 0x0c,
 105                 .reg_cs_ctrl = 0x18,
 106                 .reg_capabilities = -1,
 107                 .rx_threshold = 64,
 108                 .tx_threshold_lo = 160,
 109                 .tx_threshold_hi = 224,
 110         },
 111         {       /* LPSS_BSW_SSP */
 112                 .offset = 0x400,
 113                 .reg_general = 0x08,
 114                 .reg_ssp = 0x0c,
 115                 .reg_cs_ctrl = 0x18,
 116                 .reg_capabilities = -1,
 117                 .rx_threshold = 64,
 118                 .tx_threshold_lo = 160,
 119                 .tx_threshold_hi = 224,
 120                 .cs_sel_shift = 2,
 121                 .cs_sel_mask = 1 << 2,
 122                 .cs_num = 2,
 123         },
 124         {       /* LPSS_SPT_SSP */
 125                 .offset = 0x200,
 126                 .reg_general = -1,
 127                 .reg_ssp = 0x20,
 128                 .reg_cs_ctrl = 0x24,
 129                 .reg_capabilities = -1,
 130                 .rx_threshold = 1,
 131                 .tx_threshold_lo = 32,
 132                 .tx_threshold_hi = 56,
 133         },
 134         {       /* LPSS_BXT_SSP */
 135                 .offset = 0x200,
 136                 .reg_general = -1,
 137                 .reg_ssp = 0x20,
 138                 .reg_cs_ctrl = 0x24,
 139                 .reg_capabilities = 0xfc,
 140                 .rx_threshold = 1,
 141                 .tx_threshold_lo = 16,
 142                 .tx_threshold_hi = 48,
 143                 .cs_sel_shift = 8,
 144                 .cs_sel_mask = 3 << 8,
 145         },
 146 };
 147
 148 static inline const struct lpss_config
 149 *lpss_get_config(const struct driver_data *drv_data)
 150 {
 151         return &lpss_platforms[drv_data->ssp_type - LPSS_LPT_SSP];
 152 }
 153
 154 static bool is_lpss_ssp(const struct driver_data *drv_data)
 155 {
 156         switch (drv_data->ssp_type) {
 157         case LPSS_LPT_SSP:
 158         case LPSS_BYT_SSP:
 159         case LPSS_BSW_SSP:
 160         case LPSS_SPT_SSP:
 161         case LPSS_BXT_SSP:
 162                 return true;
 163         default:
 164                 return false;
 165         }
 166 }
 167
 168 static bool is_quark_x1000_ssp(const struct driver_data *drv_data)
 169 {
 170         return drv_data->ssp_type == QUARK_X1000_SSP;
 171 }
 172
 173 static u32 pxa2xx_spi_get_ssrc1_change_mask(const struct driver_data *drv_data)
 174 {
 175         switch (drv_data->ssp_type) {
 176         case QUARK_X1000_SSP:
 177                 return QUARK_X1000_SSCR1_CHANGE_MASK;
 178         default:
 179                 return SSCR1_CHANGE_MASK;
 180         }
 181 }
 182
 183 static u32
 184 pxa2xx_spi_get_rx_default_thre(const struct driver_data *drv_data)
 185 {
 186         switch (drv_data->ssp_type) {
 187         case QUARK_X1000_SSP:
 188                 return RX_THRESH_QUARK_X1000_DFLT;
 189         default:
 190                 return RX_THRESH_DFLT;
 191         }
 192 }
 193
 194 static bool pxa2xx_spi_txfifo_full(const struct driver_data *drv_data)
 195 {
 196         u32 mask;
 197
 198         switch (drv_data->ssp_type) {
 199         case QUARK_X1000_SSP:
 200                 mask = QUARK_X1000_SSSR_TFL_MASK;
 201                 break;
 202         default:
 203                 mask = SSSR_TFL_MASK;
 204                 break;
 205         }
 206
 207         return (pxa2xx_spi_read(drv_data, SSSR) & mask) == mask;
 208 }
 209
 210 static void pxa2xx_spi_clear_rx_thre(const struct driver_data *drv_data,
 211                                      u32 *sccr1_reg)
 212 {
 213         u32 mask;
 214
 215         switch (drv_data->ssp_type) {
 216         case QUARK_X1000_SSP:
 217                 mask = QUARK_X1000_SSCR1_RFT;
 218                 break;
 219         default:
 220                 mask = SSCR1_RFT;
 221                 break;
 222         }
 223         *sccr1_reg &= ~mask;
 224 }
 225
 226 static void pxa2xx_spi_set_rx_thre(const struct driver_data *drv_data,
 227                                    u32 *sccr1_reg, u32 threshold)
 228 {
 229         switch (drv_data->ssp_type) {
 230         case QUARK_X1000_SSP:
 231                 *sccr1_reg |= QUARK_X1000_SSCR1_RxTresh(threshold);
 232                 break;
 233         default:
 234                 *sccr1_reg |= SSCR1_RxTresh(threshold);
 235                 break;
 236         }
 237 }
 238
 239 static u32 pxa2xx_configure_sscr0(const struct driver_data *drv_data,
 240                                   u32 clk_div, u8 bits)
 241 {
 242         switch (drv_data->ssp_type) {
 243         case QUARK_X1000_SSP:
 244                 return clk_div
 245                         | QUARK_X1000_SSCR0_Motorola
 246                         | QUARK_X1000_SSCR0_DataSize(bits > 32 ? 8 : bits)
 247                         | SSCR0_SSE;
 248         default:
 249                 return clk_div
 250                         | SSCR0_Motorola
 251                         | SSCR0_DataSize(bits > 16 ? bits - 16 : bits)
 252                         | SSCR0_SSE
 253                         | (bits > 16 ? SSCR0_EDSS : 0);
 254         }
 255 }
 256
 257 /*
 258  * Read and write LPSS SSP private registers. Caller must first check that
 259  * is_lpss_ssp() returns true before these can be called.
 260  */
 261 static u32 __lpss_ssp_read_priv(struct driver_data *drv_data, unsigned offset)
 262 {
 263         WARN_ON(!drv_data->lpss_base);
 264         return readl(drv_data->lpss_base + offset);
 265 }
 266
 267 static void __lpss_ssp_write_priv(struct driver_data *drv_data,
 268                                   unsigned offset, u32 value)
 269 {
 270         WARN_ON(!drv_data->lpss_base);
 271         writel(value, drv_data->lpss_base + offset);
 272 }
 273
 274 /*
 275  * lpss_ssp_setup - perform LPSS SSP specific setup
 276  * @drv_data: pointer to the driver private data
 277  *
 278  * Perform LPSS SSP specific setup. This function must be called first if
 279  * one is going to use LPSS SSP private registers.
 280  */
 281 static void lpss_ssp_setup(struct driver_data *drv_data)
 282 {
 283         const struct lpss_config *config;
 284         u32 value;
 285
 286         config = lpss_get_config(drv_data);
 287         drv_data->lpss_base = drv_data->ioaddr + config->offset;
 288
 289         /* Enable software chip select control */
 290         value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
 291         value &= ~(LPSS_CS_CONTROL_SW_MODE | LPSS_CS_CONTROL_CS_HIGH);
 292         value |= LPSS_CS_CONTROL_SW_MODE | LPSS_CS_CONTROL_CS_HIGH;
 293         __lpss_ssp_write_priv(drv_data, config->reg_cs_ctrl, value);
 294
 295         /* Enable multiblock DMA transfers */
 296         if (drv_data->master_info->enable_dma) {
 297                 __lpss_ssp_write_priv(drv_data, config->reg_ssp, 1);
 298
 299                 if (config->reg_general >= 0) {
 300                         value = __lpss_ssp_read_priv(drv_data,
 301                                                      config->reg_general);
 302                         value |= LPSS_GENERAL_REG_RXTO_HOLDOFF_DISABLE;
 303                         __lpss_ssp_write_priv(drv_data,
 304                                               config->reg_general, value);
 305                 }
 306         }
 307 }
 308
 309 static void lpss_ssp_select_cs(struct driver_data *drv_data,
 310                                const struct lpss_config *config)
 311 {
 312         u32 value, cs;
 313
 314         if (!config->cs_sel_mask)
 315                 return;
 316
 317         value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
 318
 319         cs = drv_data->master->cur_msg->spi->chip_select;
 320         cs <<= config->cs_sel_shift;
 321         if (cs != (value & config->cs_sel_mask)) {
 322                 /*
 323                  * When switching another chip select output active the
 324                  * output must be selected first and wait 2 ssp_clk cycles
 325                  * before changing state to active. Otherwise a short
 326                  * glitch will occur on the previous chip select since
 327                  * output select is latched but state control is not.
 328                  */
 329                 value &= ~config->cs_sel_mask;
 330                 value |= cs;
 331                 __lpss_ssp_write_priv(drv_data,
 332                                       config->reg_cs_ctrl, value);
 333                 ndelay(1000000000 /
 334                        (drv_data->master->max_speed_hz / 2));
 335         }
 336 }
 337
 338 static void lpss_ssp_cs_control(struct driver_data *drv_data, bool enable)
 339 {
 340         const struct lpss_config *config;
 341         u32 value;
 342
 343         config = lpss_get_config(drv_data);
 344
 345         if (enable)
 346                 lpss_ssp_select_cs(drv_data, config);
 347
 348         value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
 349         if (enable)
 350                 value &= ~LPSS_CS_CONTROL_CS_HIGH;
 351         else
 352                 value |= LPSS_CS_CONTROL_CS_HIGH;
 353         __lpss_ssp_write_priv(drv_data, config->reg_cs_ctrl, value);
 354 }
 355
 356 static void cs_assert(struct driver_data *drv_data)
 357 {
 358         struct chip_data *chip =
 359                 spi_get_ctldata(drv_data->master->cur_msg->spi);
 360
 361         if (drv_data->ssp_type == CE4100_SSP) {
 362                 pxa2xx_spi_write(drv_data, SSSR, chip->frm);
 363                 return;
 364         }
 365
 366         if (chip->cs_control) {
 367                 chip->cs_control(PXA2XX_CS_ASSERT);
 368                 return;
 369         }
 370
 371         if (gpio_is_valid(chip->gpio_cs)) {
 372                 gpio_set_value(chip->gpio_cs, chip->gpio_cs_inverted);
 373                 return;
 374         }
 375
 376         if (is_lpss_ssp(drv_data))
 377                 lpss_ssp_cs_control(drv_data, true);
 378 }
 379
 380 static void cs_deassert(struct driver_data *drv_data)
 381 {
 382         struct chip_data *chip =
 383                 spi_get_ctldata(drv_data->master->cur_msg->spi);
 384
 385         if (drv_data->ssp_type == CE4100_SSP)
 386                 return;
 387
 388         if (chip->cs_control) {
 389                 chip->cs_control(PXA2XX_CS_DEASSERT);
 390                 return;
 391         }
 392
 393         if (gpio_is_valid(chip->gpio_cs)) {
 394                 gpio_set_value(chip->gpio_cs, !chip->gpio_cs_inverted);
 395                 return;
 396         }
 397
 398         if (is_lpss_ssp(drv_data))
 399                 lpss_ssp_cs_control(drv_data, false);
 400 }
 401
 402 int pxa2xx_spi_flush(struct driver_data *drv_data)
 403 {
 404         unsigned long limit = loops_per_jiffy << 1;
 405
 406         do {
 407                 while (pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
 408                         pxa2xx_spi_read(drv_data, SSDR);
 409         } while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_BSY) && --limit);
 410         write_SSSR_CS(drv_data, SSSR_ROR);
 411
 412         return limit;
 413 }
 414
 415 static int null_writer(struct driver_data *drv_data)
 416 {
 417         u8 n_bytes = drv_data->n_bytes;
 418
 419         if (pxa2xx_spi_txfifo_full(drv_data)
 420                 || (drv_data->tx == drv_data->tx_end))
 421                 return 0;
 422
 423         pxa2xx_spi_write(drv_data, SSDR, 0);
 424         drv_data->tx += n_bytes;
 425
 426         return 1;
 427 }
 428
 429 static int null_reader(struct driver_data *drv_data)
 430 {
 431         u8 n_bytes = drv_data->n_bytes;
 432
 433         while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
 434                && (drv_data->rx < drv_data->rx_end)) {
 435                 pxa2xx_spi_read(drv_data, SSDR);
 436                 drv_data->rx += n_bytes;
 437         }
 438
 439         return drv_data->rx == drv_data->rx_end;
 440 }
 441
 442 static int u8_writer(struct driver_data *drv_data)
 443 {
 444         if (pxa2xx_spi_txfifo_full(drv_data)
 445                 || (drv_data->tx == drv_data->tx_end))
 446                 return 0;
 447
 448         pxa2xx_spi_write(drv_data, SSDR, *(u8 *)(drv_data->tx));
 449         ++drv_data->tx;
 450
 451         return 1;
 452 }
 453
 454 static int u8_reader(struct driver_data *drv_data)
 455 {
 456         while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
 457                && (drv_data->rx < drv_data->rx_end)) {
 458                 *(u8 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
 459                 ++drv_data->rx;
 460         }
 461
 462         return drv_data->rx == drv_data->rx_end;
 463 }
 464
 465 static int u16_writer(struct driver_data *drv_data)
 466 {
 467         if (pxa2xx_spi_txfifo_full(drv_data)
 468                 || (drv_data->tx == drv_data->tx_end))
 469                 return 0;
 470
 471         pxa2xx_spi_write(drv_data, SSDR, *(u16 *)(drv_data->tx));
 472         drv_data->tx += 2;
 473
 474         return 1;
 475 }
 476
 477 static int u16_reader(struct driver_data *drv_data)
 478 {
 479         while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
 480                && (drv_data->rx < drv_data->rx_end)) {
 481                 *(u16 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
 482                 drv_data->rx += 2;
 483         }
 484
 485         return drv_data->rx == drv_data->rx_end;
 486 }
 487
 488 static int u32_writer(struct driver_data *drv_data)
 489 {
 490         if (pxa2xx_spi_txfifo_full(drv_data)
 491                 || (drv_data->tx == drv_data->tx_end))
 492                 return 0;
 493
 494         pxa2xx_spi_write(drv_data, SSDR, *(u32 *)(drv_data->tx));
 495         drv_data->tx += 4;
 496
 497         return 1;
 498 }
 499
 500 static int u32_reader(struct driver_data *drv_data)
 501 {
 502         while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
 503                && (drv_data->rx < drv_data->rx_end)) {
 504                 *(u32 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
 505                 drv_data->rx += 4;
 506         }
 507
 508         return drv_data->rx == drv_data->rx_end;
 509 }
 510
 511 void *pxa2xx_spi_next_transfer(struct driver_data *drv_data)
 512 {
 513         struct spi_message *msg = drv_data->master->cur_msg;
 514         struct spi_transfer *trans = drv_data->cur_transfer;
 515
 516         /* Move to next transfer */
 517         if (trans->transfer_list.next != &msg->transfers) {
 518                 drv_data->cur_transfer =
 519                         list_entry(trans->transfer_list.next,
 520                                         struct spi_transfer,
 521                                         transfer_list);
 522                 return RUNNING_STATE;
 523         } else
 524                 return DONE_STATE;
 525 }
 526
 527 /* caller already set message->status; dma and pio irqs are blocked */
 528 static void giveback(struct driver_data *drv_data)
 529 {
 530         struct spi_transfer* last_transfer;
 531         struct spi_message *msg;
 532         unsigned long timeout;
 533
 534         msg = drv_data->master->cur_msg;
 535         drv_data->cur_transfer = NULL;
 536
 537         last_transfer = list_last_entry(&msg->transfers, struct spi_transfer,
 538                                         transfer_list);
 539
 540         /* Delay if requested before any change in chip select */
 541         if (last_transfer->delay_usecs)
 542                 udelay(last_transfer->delay_usecs);
 543
 544         /* Wait until SSP becomes idle before deasserting the CS */
 545         timeout = jiffies + msecs_to_jiffies(10);
 546         while (pxa2xx_spi_read(drv_data, SSSR) & SSSR_BSY &&
 547                !time_after(jiffies, timeout))
 548                 cpu_relax();
 549
 550         /* Drop chip select UNLESS cs_change is true or we are returning
 551          * a message with an error, or next message is for another chip
 552          */
 553         if (!last_transfer->cs_change)
 554                 cs_deassert(drv_data);
 555         else {
 556                 struct spi_message *next_msg;
 557
 558                 /* Holding of cs was hinted, but we need to make sure
 559                  * the next message is for the same chip.  Don't waste
 560                  * time with the following tests unless this was hinted.
 561                  *
 562                  * We cannot postpone this until pump_messages, because
 563                  * after calling msg->complete (below) the driver that
 564                  * sent the current message could be unloaded, which
 565                  * could invalidate the cs_control() callback...
 566                  */
 567
 568                 /* get a pointer to the next message, if any */
 569                 next_msg = spi_get_next_queued_message(drv_data->master);
 570
 571                 /* see if the next and current messages point
 572                  * to the same chip
 573                  */
 574                 if ((next_msg && next_msg->spi != msg->spi) ||
 575                     msg->state == ERROR_STATE)
 576                         cs_deassert(drv_data);
 577         }
 578
 579         spi_finalize_current_message(drv_data->master);
 580 }
 581
 582 static void reset_sccr1(struct driver_data *drv_data)
 583 {
 584         struct chip_data *chip =
 585                 spi_get_ctldata(drv_data->master->cur_msg->spi);
 586         u32 sccr1_reg;
 587
 588         sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1) & ~drv_data->int_cr1;
 589         switch (drv_data->ssp_type) {
 590         case QUARK_X1000_SSP:
 591                 sccr1_reg &= ~QUARK_X1000_SSCR1_RFT;
 592                 break;
 593         default:
 594                 sccr1_reg &= ~SSCR1_RFT;
 595                 break;
 596         }
 597         sccr1_reg |= chip->threshold;
 598         pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
 599 }
 600
 601 static void int_error_stop(struct driver_data *drv_data, const char* msg)
 602 {
 603         /* Stop and reset SSP */
 604         write_SSSR_CS(drv_data, drv_data->clear_sr);
 605         reset_sccr1(drv_data);
 606         if (!pxa25x_ssp_comp(drv_data))
 607                 pxa2xx_spi_write(drv_data, SSTO, 0);
 608         pxa2xx_spi_flush(drv_data);
 609         pxa2xx_spi_write(drv_data, SSCR0,
 610                          pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
 611
 612         dev_err(&drv_data->pdev->dev, "%s\n", msg);
 613
 614         drv_data->master->cur_msg->state = ERROR_STATE;
 615         tasklet_schedule(&drv_data->pump_transfers);
 616 }
 617
 618 static void int_transfer_complete(struct driver_data *drv_data)
 619 {
 620         /* Clear and disable interrupts */
 621         write_SSSR_CS(drv_data, drv_data->clear_sr);
 622         reset_sccr1(drv_data);
 623         if (!pxa25x_ssp_comp(drv_data))
 624                 pxa2xx_spi_write(drv_data, SSTO, 0);
 625
 626         /* Update total byte transferred return count actual bytes read */
 627         drv_data->master->cur_msg->actual_length += drv_data->len -
 628                                 (drv_data->rx_end - drv_data->rx);
 629
 630         /* Transfer delays and chip select release are
 631          * handled in pump_transfers or giveback
 632          */
 633
 634         /* Move to next transfer */
 635         drv_data->master->cur_msg->state = pxa2xx_spi_next_transfer(drv_data);
 636
 637         /* Schedule transfer tasklet */
 638         tasklet_schedule(&drv_data->pump_transfers);
 639 }
 640
 641 static irqreturn_t interrupt_transfer(struct driver_data *drv_data)
 642 {
 643         u32 irq_mask = (pxa2xx_spi_read(drv_data, SSCR1) & SSCR1_TIE) ?
 644                        drv_data->mask_sr : drv_data->mask_sr & ~SSSR_TFS;
 645
 646         u32 irq_status = pxa2xx_spi_read(drv_data, SSSR) & irq_mask;
 647
 648         if (irq_status & SSSR_ROR) {
 649                 int_error_stop(drv_data, "interrupt_transfer: fifo overrun");
 650                 return IRQ_HANDLED;
 651         }
 652
 653         if (irq_status & SSSR_TINT) {
 654                 pxa2xx_spi_write(drv_data, SSSR, SSSR_TINT);
 655                 if (drv_data->read(drv_data)) {
 656                         int_transfer_complete(drv_data);
 657                         return IRQ_HANDLED;
 658                 }
 659         }
 660
 661         /* Drain rx fifo, Fill tx fifo and prevent overruns */
 662         do {
 663                 if (drv_data->read(drv_data)) {
 664                         int_transfer_complete(drv_data);
 665                         return IRQ_HANDLED;
 666                 }
 667         } while (drv_data->write(drv_data));
 668
 669         if (drv_data->read(drv_data)) {
 670                 int_transfer_complete(drv_data);
 671                 return IRQ_HANDLED;
 672         }
 673
 674         if (drv_data->tx == drv_data->tx_end) {
 675                 u32 bytes_left;
 676                 u32 sccr1_reg;
 677
 678                 sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1);
 679                 sccr1_reg &= ~SSCR1_TIE;
 680
 681                 /*
 682                  * PXA25x_SSP has no timeout, set up rx threshould for the
 683                  * remaining RX bytes.
 684                  */
 685                 if (pxa25x_ssp_comp(drv_data)) {
 686                         u32 rx_thre;
 687
 688                         pxa2xx_spi_clear_rx_thre(drv_data, &sccr1_reg);
 689
 690                         bytes_left = drv_data->rx_end - drv_data->rx;
 691                         switch (drv_data->n_bytes) {
 692                         case 4:
 693                                 bytes_left >>= 1;
 694                         case 2:
 695                                 bytes_left >>= 1;
 696                         }
 697
 698                         rx_thre = pxa2xx_spi_get_rx_default_thre(drv_data);
 699                         if (rx_thre > bytes_left)
 700                                 rx_thre = bytes_left;
 701
 702                         pxa2xx_spi_set_rx_thre(drv_data, &sccr1_reg, rx_thre);
 703                 }
 704                 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
 705         }
 706
 707         /* We did something */
 708         return IRQ_HANDLED;
 709 }
 710
 711 static irqreturn_t ssp_int(int irq, void *dev_id)
 712 {
 713         struct driver_data *drv_data = dev_id;
 714         u32 sccr1_reg;
 715         u32 mask = drv_data->mask_sr;
 716         u32 status;
 717
 718         /*
 719          * The IRQ might be shared with other peripherals so we must first
 720          * check that are we RPM suspended or not. If we are we assume that
 721          * the IRQ was not for us (we shouldn't be RPM suspended when the
 722          * interrupt is enabled).
 723          */
 724         if (pm_runtime_suspended(&drv_data->pdev->dev))
 725                 return IRQ_NONE;
 726
 727         /*
 728          * If the device is not yet in RPM suspended state and we get an
 729          * interrupt that is meant for another device, check if status bits
 730          * are all set to one. That means that the device is already
 731          * powered off.
 732          */
 733         status = pxa2xx_spi_read(drv_data, SSSR);
 734         if (status == ~0)
 735                 return IRQ_NONE;
 736
 737         sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1);
 738
 739         /* Ignore possible writes if we don't need to write */
 740         if (!(sccr1_reg & SSCR1_TIE))
 741                 mask &= ~SSSR_TFS;
 742
 743         /* Ignore RX timeout interrupt if it is disabled */
 744         if (!(sccr1_reg & SSCR1_TINTE))
 745                 mask &= ~SSSR_TINT;
 746
 747         if (!(status & mask))
 748                 return IRQ_NONE;
 749
 750         if (!drv_data->master->cur_msg) {
 751
 752                 pxa2xx_spi_write(drv_data, SSCR0,
 753                                  pxa2xx_spi_read(drv_data, SSCR0)
 754                                  & ~SSCR0_SSE);
 755                 pxa2xx_spi_write(drv_data, SSCR1,
 756                                  pxa2xx_spi_read(drv_data, SSCR1)
 757                                  & ~drv_data->int_cr1);
 758                 if (!pxa25x_ssp_comp(drv_data))
 759                         pxa2xx_spi_write(drv_data, SSTO, 0);
 760                 write_SSSR_CS(drv_data, drv_data->clear_sr);
 761
 762                 dev_err(&drv_data->pdev->dev,
 763                         "bad message state in interrupt handler\n");
 764
 765                 /* Never fail */
 766                 return IRQ_HANDLED;
 767         }
 768
 769         return drv_data->transfer_handler(drv_data);
 770 }
 771
 772 /*
 773  * The Quark SPI has an additional 24 bit register (DDS_CLK_RATE) to multiply
 774  * input frequency by fractions of 2^24. It also has a divider by 5.
 775  *
 776  * There are formulas to get baud rate value for given input frequency and
 777  * divider parameters, such as DDS_CLK_RATE and SCR:
 778  *
 779  * Fsys = 200MHz
 780  *
 781  * Fssp = Fsys * DDS_CLK_RATE / 2^24                    (1)
 782  * Baud rate = Fsclk = Fssp / (2 * (SCR + 1))           (2)
 783  *
 784  * DDS_CLK_RATE either 2^n or 2^n / 5.
 785  * SCR is in range 0 .. 255
 786  *
 787  * Divisor = 5^i * 2^j * 2 * k
 788  *       i = [0, 1]      i = 1 iff j = 0 or j > 3
 789  *       j = [0, 23]     j = 0 iff i = 1
 790  *       k = [1, 256]
 791  * Special case: j = 0, i = 1: Divisor = 2 / 5
 792  *
 793  * Accordingly to the specification the recommended values for DDS_CLK_RATE
 794  * are:
 795  *      Case 1:         2^n, n = [0, 23]
 796  *      Case 2:         2^24 * 2 / 5 (0x666666)
 797  *      Case 3:         less than or equal to 2^24 / 5 / 16 (0x33333)
 798  *
 799  * In all cases the lowest possible value is better.
 800  *
 801  * The function calculates parameters for all cases and chooses the one closest
 802  * to the asked baud rate.
 803  */
 804 static unsigned int quark_x1000_get_clk_div(int rate, u32 *dds)
 805 {
 806         unsigned long xtal = 200000000;
 807         unsigned long fref = xtal / 2;          /* mandatory division by 2,
 808                                                    see (2) */
 809                                                 /* case 3 */
 810         unsigned long fref1 = fref / 2;         /* case 1 */
 811         unsigned long fref2 = fref * 2 / 5;     /* case 2 */
 812         unsigned long scale;
 813         unsigned long q, q1, q2;
 814         long r, r1, r2;
 815         u32 mul;
 816
 817         /* Case 1 */
 818
 819         /* Set initial value for DDS_CLK_RATE */
 820         mul = (1 << 24) >> 1;
 821
 822         /* Calculate initial quot */
 823         q1 = DIV_ROUND_UP(fref1, rate);
 824
 825         /* Scale q1 if it's too big */
 826         if (q1 > 256) {
 827                 /* Scale q1 to range [1, 512] */
 828                 scale = fls_long(q1 - 1);
 829                 if (scale > 9) {
 830                         q1 >>= scale - 9;
 831                         mul >>= scale - 9;
 832                 }
 833
 834                 /* Round the result if we have a remainder */
 835                 q1 += q1 & 1;
 836         }
 837
 838         /* Decrease DDS_CLK_RATE as much as we can without loss in precision */
 839         scale = __ffs(q1);
 840         q1 >>= scale;
 841         mul >>= scale;
 842
 843         /* Get the remainder */
 844         r1 = abs(fref1 / (1 << (24 - fls_long(mul))) / q1 - rate);
 845
 846         /* Case 2 */
 847
 848         q2 = DIV_ROUND_UP(fref2, rate);
 849         r2 = abs(fref2 / q2 - rate);
 850
 851         /*
 852          * Choose the best between two: less remainder we have the better. We
 853          * can't go case 2 if q2 is greater than 256 since SCR register can
 854          * hold only values 0 .. 255.
 855          */
 856         if (r2 >= r1 || q2 > 256) {
 857                 /* case 1 is better */
 858                 r = r1;
 859                 q = q1;
 860         } else {
 861                 /* case 2 is better */
 862                 r = r2;
 863                 q = q2;
 864                 mul = (1 << 24) * 2 / 5;
 865         }
 866
 867         /* Check case 3 only if the divisor is big enough */
 868         if (fref / rate >= 80) {
 869                 u64 fssp;
 870                 u32 m;
 871
 872                 /* Calculate initial quot */
 873                 q1 = DIV_ROUND_UP(fref, rate);
 874                 m = (1 << 24) / q1;
 875
 876                 /* Get the remainder */
 877                 fssp = (u64)fref * m;
 878                 do_div(fssp, 1 << 24);
 879                 r1 = abs(fssp - rate);
 880
 881                 /* Choose this one if it suits better */
 882                 if (r1 < r) {
 883                         /* case 3 is better */
 884                         q = 1;
 885                         mul = m;
 886                 }
 887         }
 888
 889         *dds = mul;
 890         return q - 1;
 891 }
 892
 893 static unsigned int ssp_get_clk_div(struct driver_data *drv_data, int rate)
 894 {
 895         unsigned long ssp_clk = drv_data->master->max_speed_hz;
 896         const struct ssp_device *ssp = drv_data->ssp;
 897
 898         rate = min_t(int, ssp_clk, rate);
 899
 900         if (ssp->type == PXA25x_SSP || ssp->type == CE4100_SSP)
 901                 return (ssp_clk / (2 * rate) - 1) & 0xff;
 902         else
 903                 return (ssp_clk / rate - 1) & 0xfff;
 904 }
 905
 906 static unsigned int pxa2xx_ssp_get_clk_div(struct driver_data *drv_data,
 907                                            int rate)
 908 {
 909         struct chip_data *chip =
 910                 spi_get_ctldata(drv_data->master->cur_msg->spi);
 911         unsigned int clk_div;
 912
 913         switch (drv_data->ssp_type) {
 914         case QUARK_X1000_SSP:
 915                 clk_div = quark_x1000_get_clk_div(rate, &chip->dds_rate);
 916                 break;
 917         default:
 918                 clk_div = ssp_get_clk_div(drv_data, rate);
 919                 break;
 920         }
 921         return clk_div << 8;
 922 }
 923
 924 static bool pxa2xx_spi_can_dma(struct spi_master *master,
 925                                struct spi_device *spi,
 926                                struct spi_transfer *xfer)
 927 {
 928         struct chip_data *chip = spi_get_ctldata(spi);
 929
 930         return chip->enable_dma &&
 931                xfer->len <= MAX_DMA_LEN &&
 932                xfer->len >= chip->dma_burst_size;
 933 }
 934
 935 static void pump_transfers(unsigned long data)
 936 {
 937         struct driver_data *drv_data = (struct driver_data *)data;
 938         struct spi_master *master = drv_data->master;
 939         struct spi_message *message = master->cur_msg;
 940         struct chip_data *chip = spi_get_ctldata(message->spi);
 941         u32 dma_thresh = chip->dma_threshold;
 942         u32 dma_burst = chip->dma_burst_size;
 943         u32 change_mask = pxa2xx_spi_get_ssrc1_change_mask(drv_data);
 944         struct spi_transfer *transfer;
 945         struct spi_transfer *previous;
 946         u32 clk_div;
 947         u8 bits;
 948         u32 speed;
 949         u32 cr0;
 950         u32 cr1;
 951         int err;
 952         int dma_mapped;
 953
 954         /* Get current state information */
 955         transfer = drv_data->cur_transfer;
 956
 957         /* Handle for abort */
 958         if (message->state == ERROR_STATE) {
 959                 message->status = -EIO;
 960                 giveback(drv_data);
 961                 return;
 962         }
 963
 964         /* Handle end of message */
 965         if (message->state == DONE_STATE) {
 966                 message->status = 0;
 967                 giveback(drv_data);
 968                 return;
 969         }
 970
 971         /* Delay if requested at end of transfer before CS change */
 972         if (message->state == RUNNING_STATE) {
 973                 previous = list_entry(transfer->transfer_list.prev,
 974                                         struct spi_transfer,
 975                                         transfer_list);
 976                 if (previous->delay_usecs)
 977                         udelay(previous->delay_usecs);
 978
 979                 /* Drop chip select only if cs_change is requested */
 980                 if (previous->cs_change)
 981                         cs_deassert(drv_data);
 982         }
 983
 984         /* Check if we can DMA this transfer */
 985         if (transfer->len > MAX_DMA_LEN && chip->enable_dma) {
 986
 987                 /* reject already-mapped transfers; PIO won't always work */
 988                 if (message->is_dma_mapped
 989                                 || transfer->rx_dma || transfer->tx_dma) {
 990                         dev_err(&drv_data->pdev->dev,
 991                                 "pump_transfers: mapped transfer length of "
 992                                 "%u is greater than %d\n",
 993                                 transfer->len, MAX_DMA_LEN);
 994                         message->status = -EINVAL;
 995                         giveback(drv_data);
 996                         return;
 997                 }
 998
 999                 /* warn ... we force this to PIO mode */
1000                 dev_warn_ratelimited(&message->spi->dev,
1001                                      "pump_transfers: DMA disabled for transfer length %ld "
1002                                      "greater than %d\n",
1003                                      (long)drv_data->len, MAX_DMA_LEN);
1004         }
1005
1006         /* Setup the transfer state based on the type of transfer */
1007         if (pxa2xx_spi_flush(drv_data) == 0) {
1008                 dev_err(&drv_data->pdev->dev, "pump_transfers: flush failed\n");
1009                 message->status = -EIO;
1010                 giveback(drv_data);
1011                 return;
1012         }
1013         drv_data->n_bytes = chip->n_bytes;
1014         drv_data->tx = (void *)transfer->tx_buf;
1015         drv_data->tx_end = drv_data->tx + transfer->len;
1016         drv_data->rx = transfer->rx_buf;
1017         drv_data->rx_end = drv_data->rx + transfer->len;
1018         drv_data->len = transfer->len;
1019         drv_data->write = drv_data->tx ? chip->write : null_writer;
1020         drv_data->read = drv_data->rx ? chip->read : null_reader;
1021
1022         /* Change speed and bit per word on a per transfer */
1023         bits = transfer->bits_per_word;
1024         speed = transfer->speed_hz;
1025
1026         clk_div = pxa2xx_ssp_get_clk_div(drv_data, speed);
1027
1028         if (bits <= 8) {
1029                 drv_data->n_bytes = 1;
1030                 drv_data->read = drv_data->read != null_reader ?
1031                                         u8_reader : null_reader;
1032                 drv_data->write = drv_data->write != null_writer ?
1033                                         u8_writer : null_writer;
1034         } else if (bits <= 16) {
1035                 drv_data->n_bytes = 2;
1036                 drv_data->read = drv_data->read != null_reader ?
1037                                         u16_reader : null_reader;
1038                 drv_data->write = drv_data->write != null_writer ?
1039                                         u16_writer : null_writer;
1040         } else if (bits <= 32) {
1041                 drv_data->n_bytes = 4;
1042                 drv_data->read = drv_data->read != null_reader ?
1043                                         u32_reader : null_reader;
1044                 drv_data->write = drv_data->write != null_writer ?
1045                                         u32_writer : null_writer;
1046         }
1047         /*
1048          * if bits/word is changed in dma mode, then must check the
1049          * thresholds and burst also
1050          */
1051         if (chip->enable_dma) {
1052                 if (pxa2xx_spi_set_dma_burst_and_threshold(chip,
1053                                                 message->spi,
1054                                                 bits, &dma_burst,
1055                                                 &dma_thresh))
1056                         dev_warn_ratelimited(&message->spi->dev,
1057                                              "pump_transfers: DMA burst size reduced to match bits_per_word\n");
1058         }
1059
1060         message->state = RUNNING_STATE;
1061
1062         dma_mapped = master->can_dma &&
1063                      master->can_dma(master, message->spi, transfer) &&
1064                      master->cur_msg_mapped;
1065         if (dma_mapped) {
1066
1067                 /* Ensure we have the correct interrupt handler */
1068                 drv_data->transfer_handler = pxa2xx_spi_dma_transfer;
1069
1070                 err = pxa2xx_spi_dma_prepare(drv_data, dma_burst);
1071                 if (err) {
1072                         message->status = err;
1073                         giveback(drv_data);
1074                         return;
1075                 }
1076
1077                 /* Clear status and start DMA engine */
1078                 cr1 = chip->cr1 | dma_thresh | drv_data->dma_cr1;
1079                 pxa2xx_spi_write(drv_data, SSSR, drv_data->clear_sr);
1080
1081                 pxa2xx_spi_dma_start(drv_data);
1082         } else {
1083                 /* Ensure we have the correct interrupt handler */
1084                 drv_data->transfer_handler = interrupt_transfer;
1085
1086                 /* Clear status  */
1087                 cr1 = chip->cr1 | chip->threshold | drv_data->int_cr1;
1088                 write_SSSR_CS(drv_data, drv_data->clear_sr);
1089         }
1090
1091         /* NOTE:  PXA25x_SSP _could_ use external clocking ... */
1092         cr0 = pxa2xx_configure_sscr0(drv_data, clk_div, bits);
1093         if (!pxa25x_ssp_comp(drv_data))
1094                 dev_dbg(&message->spi->dev, "%u Hz actual, %s\n",
1095                         master->max_speed_hz
1096                                 / (1 + ((cr0 & SSCR0_SCR(0xfff)) >> 8)),
1097                         dma_mapped ? "DMA" : "PIO");
1098         else
1099                 dev_dbg(&message->spi->dev, "%u Hz actual, %s\n",
1100                         master->max_speed_hz / 2
1101                                 / (1 + ((cr0 & SSCR0_SCR(0x0ff)) >> 8)),
1102                         dma_mapped ? "DMA" : "PIO");
1103
1104         if (is_lpss_ssp(drv_data)) {
1105                 if ((pxa2xx_spi_read(drv_data, SSIRF) & 0xff)
1106                     != chip->lpss_rx_threshold)
1107                         pxa2xx_spi_write(drv_data, SSIRF,
1108                                          chip->lpss_rx_threshold);
1109                 if ((pxa2xx_spi_read(drv_data, SSITF) & 0xffff)
1110                     != chip->lpss_tx_threshold)
1111                         pxa2xx_spi_write(drv_data, SSITF,
1112                                          chip->lpss_tx_threshold);
1113         }
1114
1115         if (is_quark_x1000_ssp(drv_data) &&
1116             (pxa2xx_spi_read(drv_data, DDS_RATE) != chip->dds_rate))
1117                 pxa2xx_spi_write(drv_data, DDS_RATE, chip->dds_rate);
1118
1119         /* see if we need to reload the config registers */
1120         if ((pxa2xx_spi_read(drv_data, SSCR0) != cr0)
1121             || (pxa2xx_spi_read(drv_data, SSCR1) & change_mask)
1122             != (cr1 & change_mask)) {
1123                 /* stop the SSP, and update the other bits */
1124                 pxa2xx_spi_write(drv_data, SSCR0, cr0 & ~SSCR0_SSE);
1125                 if (!pxa25x_ssp_comp(drv_data))
1126                         pxa2xx_spi_write(drv_data, SSTO, chip->timeout);
1127                 /* first set CR1 without interrupt and service enables */
1128                 pxa2xx_spi_write(drv_data, SSCR1, cr1 & change_mask);
1129                 /* restart the SSP */
1130                 pxa2xx_spi_write(drv_data, SSCR0, cr0);
1131
1132         } else {
1133                 if (!pxa25x_ssp_comp(drv_data))
1134                         pxa2xx_spi_write(drv_data, SSTO, chip->timeout);
1135         }
1136
1137         cs_assert(drv_data);
1138
1139         /* after chip select, release the data by enabling service
1140          * requests and interrupts, without changing any mode bits */
1141         pxa2xx_spi_write(drv_data, SSCR1, cr1);
1142 }
1143
1144 static int pxa2xx_spi_transfer_one_message(struct spi_master *master,
1145                                            struct spi_message *msg)
1146 {
1147         struct driver_data *drv_data = spi_master_get_devdata(master);
1148
1149         /* Initial message state*/
1150         msg->state = START_STATE;
1151         drv_data->cur_transfer = list_entry(msg->transfers.next,
1152                                                 struct spi_transfer,
1153                                                 transfer_list);
1154
1155         /* Mark as busy and launch transfers */
1156         tasklet_schedule(&drv_data->pump_transfers);
1157         return 0;
1158 }
1159
1160 static int pxa2xx_spi_unprepare_transfer(struct spi_master *master)
1161 {
1162         struct driver_data *drv_data = spi_master_get_devdata(master);
1163
1164         /* Disable the SSP now */
1165         pxa2xx_spi_write(drv_data, SSCR0,
1166                          pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
1167
1168         return 0;
1169 }
1170
1171 static int setup_cs(struct spi_device *spi, struct chip_data *chip,
1172                     struct pxa2xx_spi_chip *chip_info)
1173 {
1174         int err = 0;
1175
1176         if (chip == NULL || chip_info == NULL)
1177                 return 0;
1178
1179         /* NOTE: setup() can be called multiple times, possibly with
1180          * different chip_info, release previously requested GPIO
1181          */
1182         if (gpio_is_valid(chip->gpio_cs))
1183                 gpio_free(chip->gpio_cs);
1184
1185         /* If (*cs_control) is provided, ignore GPIO chip select */
1186         if (chip_info->cs_control) {
1187                 chip->cs_control = chip_info->cs_control;
1188                 return 0;
1189         }
1190
1191         if (gpio_is_valid(chip_info->gpio_cs)) {
1192                 err = gpio_request(chip_info->gpio_cs, "SPI_CS");
1193                 if (err) {
1194                         dev_err(&spi->dev, "failed to request chip select GPIO%d\n",
1195                                 chip_info->gpio_cs);
1196                         return err;
1197                 }
1198
1199                 chip->gpio_cs = chip_info->gpio_cs;
1200                 chip->gpio_cs_inverted = spi->mode & SPI_CS_HIGH;
1201
1202                 err = gpio_direction_output(chip->gpio_cs,
1203                                         !chip->gpio_cs_inverted);
1204         }
1205
1206         return err;
1207 }
1208
1209 static int setup(struct spi_device *spi)
1210 {
1211         struct pxa2xx_spi_chip *chip_info;
1212         struct chip_data *chip;
1213         const struct lpss_config *config;
1214         struct driver_data *drv_data = spi_master_get_devdata(spi->master);
1215         uint tx_thres, tx_hi_thres, rx_thres;
1216
1217         switch (drv_data->ssp_type) {
1218         case QUARK_X1000_SSP:
1219                 tx_thres = TX_THRESH_QUARK_X1000_DFLT;
1220                 tx_hi_thres = 0;
1221                 rx_thres = RX_THRESH_QUARK_X1000_DFLT;
1222                 break;
1223         case LPSS_LPT_SSP:
1224         case LPSS_BYT_SSP:
1225         case LPSS_BSW_SSP:
1226         case LPSS_SPT_SSP:
1227         case LPSS_BXT_SSP:
1228                 config = lpss_get_config(drv_data);
1229                 tx_thres = config->tx_threshold_lo;
1230                 tx_hi_thres = config->tx_threshold_hi;
1231                 rx_thres = config->rx_threshold;
1232                 break;
1233         default:
1234                 tx_thres = TX_THRESH_DFLT;
1235                 tx_hi_thres = 0;
1236                 rx_thres = RX_THRESH_DFLT;
1237                 break;
1238         }
1239
1240         /* Only alloc on first setup */
1241         chip = spi_get_ctldata(spi);
1242         if (!chip) {
1243                 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
1244                 if (!chip)
1245                         return -ENOMEM;
1246
1247                 if (drv_data->ssp_type == CE4100_SSP) {
1248                         if (spi->chip_select > 4) {
1249                                 dev_err(&spi->dev,
1250                                         "failed setup: cs number must not be > 4.\n");
1251                                 kfree(chip);
1252                                 return -EINVAL;
1253                         }
1254
1255                         chip->frm = spi->chip_select;
1256                 } else
1257                         chip->gpio_cs = -1;
1258                 chip->enable_dma = drv_data->master_info->enable_dma;
1259                 chip->timeout = TIMOUT_DFLT;
1260         }
1261
1262         /* protocol drivers may change the chip settings, so...
1263          * if chip_info exists, use it */
1264         chip_info = spi->controller_data;
1265
1266         /* chip_info isn't always needed */
1267         chip->cr1 = 0;
1268         if (chip_info) {
1269                 if (chip_info->timeout)
1270                         chip->timeout = chip_info->timeout;
1271                 if (chip_info->tx_threshold)
1272                         tx_thres = chip_info->tx_threshold;
1273                 if (chip_info->tx_hi_threshold)
1274                         tx_hi_thres = chip_info->tx_hi_threshold;
1275                 if (chip_info->rx_threshold)
1276                         rx_thres = chip_info->rx_threshold;
1277                 chip->dma_threshold = 0;
1278                 if (chip_info->enable_loopback)
1279                         chip->cr1 = SSCR1_LBM;
1280         }
1281
1282         chip->lpss_rx_threshold = SSIRF_RxThresh(rx_thres);
1283         chip->lpss_tx_threshold = SSITF_TxLoThresh(tx_thres)
1284                                 | SSITF_TxHiThresh(tx_hi_thres);
1285
1286         /* set dma burst and threshold outside of chip_info path so that if
1287          * chip_info goes away after setting chip->enable_dma, the
1288          * burst and threshold can still respond to changes in bits_per_word */
1289         if (chip->enable_dma) {
1290                 /* set up legal burst and threshold for dma */
1291                 if (pxa2xx_spi_set_dma_burst_and_threshold(chip, spi,
1292                                                 spi->bits_per_word,
1293                                                 &chip->dma_burst_size,
1294                                                 &chip->dma_threshold)) {
1295                         dev_warn(&spi->dev,
1296                                  "in setup: DMA burst size reduced to match bits_per_word\n");
1297                 }
1298         }
1299
1300         switch (drv_data->ssp_type) {
1301         case QUARK_X1000_SSP:
1302                 chip->threshold = (QUARK_X1000_SSCR1_RxTresh(rx_thres)
1303                                    & QUARK_X1000_SSCR1_RFT)
1304                                    | (QUARK_X1000_SSCR1_TxTresh(tx_thres)
1305                                    & QUARK_X1000_SSCR1_TFT);
1306                 break;
1307         default:
1308                 chip->threshold = (SSCR1_RxTresh(rx_thres) & SSCR1_RFT) |
1309                         (SSCR1_TxTresh(tx_thres) & SSCR1_TFT);
1310                 break;
1311         }
1312
1313         chip->cr1 &= ~(SSCR1_SPO | SSCR1_SPH);
1314         chip->cr1 |= (((spi->mode & SPI_CPHA) != 0) ? SSCR1_SPH : 0)
1315                         | (((spi->mode & SPI_CPOL) != 0) ? SSCR1_SPO : 0);
1316
1317         if (spi->mode & SPI_LOOP)
1318                 chip->cr1 |= SSCR1_LBM;
1319
1320         if (spi->bits_per_word <= 8) {
1321                 chip->n_bytes = 1;
1322                 chip->read = u8_reader;
1323                 chip->write = u8_writer;
1324         } else if (spi->bits_per_word <= 16) {
1325                 chip->n_bytes = 2;
1326                 chip->read = u16_reader;
1327                 chip->write = u16_writer;
1328         } else if (spi->bits_per_word <= 32) {
1329                 chip->n_bytes = 4;
1330                 chip->read = u32_reader;
1331                 chip->write = u32_writer;
1332         }
1333
1334         spi_set_ctldata(spi, chip);
1335
1336         if (drv_data->ssp_type == CE4100_SSP)
1337                 return 0;
1338
1339         return setup_cs(spi, chip, chip_info);
1340 }
1341
1342 static void cleanup(struct spi_device *spi)
1343 {
1344         struct chip_data *chip = spi_get_ctldata(spi);
1345         struct driver_data *drv_data = spi_master_get_devdata(spi->master);
1346
1347         if (!chip)
1348                 return;
1349
1350         if (drv_data->ssp_type != CE4100_SSP && gpio_is_valid(chip->gpio_cs))
1351                 gpio_free(chip->gpio_cs);
1352
1353         kfree(chip);
1354 }
1355
1356 #ifdef CONFIG_PCI
1357 #ifdef CONFIG_ACPI
1358
1359 static const struct acpi_device_id pxa2xx_spi_acpi_match[] = {
1360         { "INT33C0", LPSS_LPT_SSP },
1361         { "INT33C1", LPSS_LPT_SSP },
1362         { "INT3430", LPSS_LPT_SSP },
1363         { "INT3431", LPSS_LPT_SSP },
1364         { "80860F0E", LPSS_BYT_SSP },
1365         { "8086228E", LPSS_BSW_SSP },
1366         { },
1367 };
1368 MODULE_DEVICE_TABLE(acpi, pxa2xx_spi_acpi_match);
1369
1370 static int pxa2xx_spi_get_port_id(struct acpi_device *adev)
1371 {
1372         unsigned int devid;
1373         int port_id = -1;
1374
1375         if (adev && adev->pnp.unique_id &&
1376             !kstrtouint(adev->pnp.unique_id, 0, &devid))
1377                 port_id = devid;
1378         return port_id;
1379 }
1380 #else /* !CONFIG_ACPI */
1381 static int pxa2xx_spi_get_port_id(struct acpi_device *adev)
1382 {
1383         return -1;
1384 }
1385 #endif
1386
1387 /*
1388  * PCI IDs of compound devices that integrate both host controller and private
1389  * integrated DMA engine. Please note these are not used in module
1390  * autoloading and probing in this module but matching the LPSS SSP type.
1391  */
1392 static const struct pci_device_id pxa2xx_spi_pci_compound_match[] = {
1393         /* SPT-LP */
1394         { PCI_VDEVICE(INTEL, 0x9d29), LPSS_SPT_SSP },
1395         { PCI_VDEVICE(INTEL, 0x9d2a), LPSS_SPT_SSP },
1396         /* SPT-H */
1397         { PCI_VDEVICE(INTEL, 0xa129), LPSS_SPT_SSP },
1398         { PCI_VDEVICE(INTEL, 0xa12a), LPSS_SPT_SSP },
1399         /* KBL-H */
1400         { PCI_VDEVICE(INTEL, 0xa2a9), LPSS_SPT_SSP },
1401         { PCI_VDEVICE(INTEL, 0xa2aa), LPSS_SPT_SSP },
1402         /* BXT A-Step */
1403         { PCI_VDEVICE(INTEL, 0x0ac2), LPSS_BXT_SSP },
1404         { PCI_VDEVICE(INTEL, 0x0ac4), LPSS_BXT_SSP },
1405         { PCI_VDEVICE(INTEL, 0x0ac6), LPSS_BXT_SSP },
1406         /* BXT B-Step */
1407         { PCI_VDEVICE(INTEL, 0x1ac2), LPSS_BXT_SSP },
1408         { PCI_VDEVICE(INTEL, 0x1ac4), LPSS_BXT_SSP },
1409         { PCI_VDEVICE(INTEL, 0x1ac6), LPSS_BXT_SSP },
1410         /* APL */
1411         { PCI_VDEVICE(INTEL, 0x5ac2), LPSS_BXT_SSP },
1412         { PCI_VDEVICE(INTEL, 0x5ac4), LPSS_BXT_SSP },
1413         { PCI_VDEVICE(INTEL, 0x5ac6), LPSS_BXT_SSP },
1414         { },
1415 };
1416
1417 static bool pxa2xx_spi_idma_filter(struct dma_chan *chan, void *param)
1418 {
1419         struct device *dev = param;
1420
1421         if (dev != chan->device->dev->parent)
1422                 return false;
1423
1424         return true;
1425 }
1426
1427 static struct pxa2xx_spi_master *
1428 pxa2xx_spi_init_pdata(struct platform_device *pdev)
1429 {
1430         struct pxa2xx_spi_master *pdata;
1431         struct acpi_device *adev;
1432         struct ssp_device *ssp;
1433         struct resource *res;
1434         const struct acpi_device_id *adev_id = NULL;
1435         const struct pci_device_id *pcidev_id = NULL;
1436         int type;
1437
1438         adev = ACPI_COMPANION(&pdev->dev);
1439
1440         if (dev_is_pci(pdev->dev.parent))
1441                 pcidev_id = pci_match_id(pxa2xx_spi_pci_compound_match,
1442                                          to_pci_dev(pdev->dev.parent));
1443         else if (adev)
1444                 adev_id = acpi_match_device(pdev->dev.driver->acpi_match_table,
1445                                             &pdev->dev);
1446         else
1447                 return NULL;
1448
1449         if (adev_id)
1450                 type = (int)adev_id->driver_data;
1451         else if (pcidev_id)
1452                 type = (int)pcidev_id->driver_data;
1453         else
1454                 return NULL;
1455
1456         pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
1457         if (!pdata)
1458                 return NULL;
1459
1460         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1461         if (!res)
1462                 return NULL;
1463
1464         ssp = &pdata->ssp;
1465
1466         ssp->phys_base = res->start;
1467         ssp->mmio_base = devm_ioremap_resource(&pdev->dev, res);
1468         if (IS_ERR(ssp->mmio_base))
1469                 return NULL;
1470
1471         if (pcidev_id) {
1472                 pdata->tx_param = pdev->dev.parent;
1473                 pdata->rx_param = pdev->dev.parent;
1474                 pdata->dma_filter = pxa2xx_spi_idma_filter;
1475         }
1476
1477         ssp->clk = devm_clk_get(&pdev->dev, NULL);
1478         ssp->irq = platform_get_irq(pdev, 0);
1479         ssp->type = type;
1480         ssp->pdev = pdev;
1481         ssp->port_id = pxa2xx_spi_get_port_id(adev);
1482
1483         pdata->num_chipselect = 1;
1484         pdata->enable_dma = true;
1485
1486         return pdata;
1487 }
1488
1489 #else /* !CONFIG_PCI */
1490 static inline struct pxa2xx_spi_master *
1491 pxa2xx_spi_init_pdata(struct platform_device *pdev)
1492 {
1493         return NULL;
1494 }
1495 #endif
1496
1497 static int pxa2xx_spi_fw_translate_cs(struct spi_master *master, unsigned cs)
1498 {
1499         struct driver_data *drv_data = spi_master_get_devdata(master);
1500
1501         if (has_acpi_companion(&drv_data->pdev->dev)) {
1502                 switch (drv_data->ssp_type) {
1503                 /*
1504                  * For Atoms the ACPI DeviceSelection used by the Windows
1505                  * driver starts from 1 instead of 0 so translate it here
1506                  * to match what Linux expects.
1507                  */
1508                 case LPSS_BYT_SSP:
1509                 case LPSS_BSW_SSP:
1510                         return cs - 1;
1511
1512                 default:
1513                         break;
1514                 }
1515         }
1516
1517         return cs;
1518 }
1519
1520 static int pxa2xx_spi_probe(struct platform_device *pdev)
1521 {
1522         struct device *dev = &pdev->dev;
1523         struct pxa2xx_spi_master *platform_info;
1524         struct spi_master *master;
1525         struct driver_data *drv_data;
1526         struct ssp_device *ssp;
1527         const struct lpss_config *config;
1528         int status;
1529         u32 tmp;
1530
1531         platform_info = dev_get_platdata(dev);
1532         if (!platform_info) {
1533                 platform_info = pxa2xx_spi_init_pdata(pdev);
1534                 if (!platform_info) {
1535                         dev_err(&pdev->dev, "missing platform data\n");
1536                         return -ENODEV;
1537                 }
1538         }
1539
1540         ssp = pxa_ssp_request(pdev->id, pdev->name);
1541         if (!ssp)
1542                 ssp = &platform_info->ssp;
1543
1544         if (!ssp->mmio_base) {
1545                 dev_err(&pdev->dev, "failed to get ssp\n");
1546                 return -ENODEV;
1547         }
1548
1549         master = spi_alloc_master(dev, sizeof(struct driver_data));
1550         if (!master) {
1551                 dev_err(&pdev->dev, "cannot alloc spi_master\n");
1552                 pxa_ssp_free(ssp);
1553                 return -ENOMEM;
1554         }
1555         drv_data = spi_master_get_devdata(master);
1556         drv_data->master = master;
1557         drv_data->master_info = platform_info;
1558         drv_data->pdev = pdev;
1559         drv_data->ssp = ssp;
1560
1561         master->dev.of_node = pdev->dev.of_node;
1562         /* the spi->mode bits understood by this driver: */
1563         master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LOOP;
1564
1565         master->bus_num = ssp->port_id;
1566         master->dma_alignment = DMA_ALIGNMENT;
1567         master->cleanup = cleanup;
1568         master->setup = setup;
1569         master->transfer_one_message = pxa2xx_spi_transfer_one_message;
1570         master->unprepare_transfer_hardware = pxa2xx_spi_unprepare_transfer;
1571         master->fw_translate_cs = pxa2xx_spi_fw_translate_cs;
1572         master->auto_runtime_pm = true;
1573         master->flags = SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX;
1574
1575         drv_data->ssp_type = ssp->type;
1576
1577         drv_data->ioaddr = ssp->mmio_base;
1578         drv_data->ssdr_physical = ssp->phys_base + SSDR;
1579         if (pxa25x_ssp_comp(drv_data)) {
1580                 switch (drv_data->ssp_type) {
1581                 case QUARK_X1000_SSP:
1582                         master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1583                         break;
1584                 default:
1585                         master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
1586                         break;
1587                 }
1588
1589                 drv_data->int_cr1 = SSCR1_TIE | SSCR1_RIE;
1590                 drv_data->dma_cr1 = 0;
1591                 drv_data->clear_sr = SSSR_ROR;
1592                 drv_data->mask_sr = SSSR_RFS | SSSR_TFS | SSSR_ROR;
1593         } else {
1594                 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1595                 drv_data->int_cr1 = SSCR1_TIE | SSCR1_RIE | SSCR1_TINTE;
1596                 drv_data->dma_cr1 = DEFAULT_DMA_CR1;
1597                 drv_data->clear_sr = SSSR_ROR | SSSR_TINT;
1598                 drv_data->mask_sr = SSSR_TINT | SSSR_RFS | SSSR_TFS | SSSR_ROR;
1599         }
1600
1601         status = request_irq(ssp->irq, ssp_int, IRQF_SHARED, dev_name(dev),
1602                         drv_data);
1603         if (status < 0) {
1604                 dev_err(&pdev->dev, "cannot get IRQ %d\n", ssp->irq);
1605                 goto out_error_master_alloc;
1606         }
1607
1608         /* Setup DMA if requested */
1609         if (platform_info->enable_dma) {
1610                 status = pxa2xx_spi_dma_setup(drv_data);
1611                 if (status) {
1612                         dev_dbg(dev, "no DMA channels available, using PIO\n");
1613                         platform_info->enable_dma = false;
1614                 } else {
1615                         master->can_dma = pxa2xx_spi_can_dma;
1616                 }
1617         }
1618
1619         /* Enable SOC clock */
1620         clk_prepare_enable(ssp->clk);
1621
1622         master->max_speed_hz = clk_get_rate(ssp->clk);
1623
1624         /* Load default SSP configuration */
1625         pxa2xx_spi_write(drv_data, SSCR0, 0);
1626         switch (drv_data->ssp_type) {
1627         case QUARK_X1000_SSP:
1628                 tmp = QUARK_X1000_SSCR1_RxTresh(RX_THRESH_QUARK_X1000_DFLT)
1629                       | QUARK_X1000_SSCR1_TxTresh(TX_THRESH_QUARK_X1000_DFLT);
1630                 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1631
1632                 /* using the Motorola SPI protocol and use 8 bit frame */
1633                 pxa2xx_spi_write(drv_data, SSCR0,
1634                                  QUARK_X1000_SSCR0_Motorola
1635                                  | QUARK_X1000_SSCR0_DataSize(8));
1636                 break;
1637         default:
1638                 tmp = SSCR1_RxTresh(RX_THRESH_DFLT) |
1639                       SSCR1_TxTresh(TX_THRESH_DFLT);
1640                 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1641                 tmp = SSCR0_SCR(2) | SSCR0_Motorola | SSCR0_DataSize(8);
1642                 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1643                 break;
1644         }
1645
1646         if (!pxa25x_ssp_comp(drv_data))
1647                 pxa2xx_spi_write(drv_data, SSTO, 0);
1648
1649         if (!is_quark_x1000_ssp(drv_data))
1650                 pxa2xx_spi_write(drv_data, SSPSP, 0);
1651
1652         if (is_lpss_ssp(drv_data)) {
1653                 lpss_ssp_setup(drv_data);
1654                 config = lpss_get_config(drv_data);
1655                 if (config->reg_capabilities >= 0) {
1656                         tmp = __lpss_ssp_read_priv(drv_data,
1657                                                    config->reg_capabilities);
1658                         tmp &= LPSS_CAPS_CS_EN_MASK;
1659                         tmp >>= LPSS_CAPS_CS_EN_SHIFT;
1660                         platform_info->num_chipselect = ffz(tmp);
1661                 } else if (config->cs_num) {
1662                         platform_info->num_chipselect = config->cs_num;
1663                 }
1664         }
1665         master->num_chipselect = platform_info->num_chipselect;
1666
1667         tasklet_init(&drv_data->pump_transfers, pump_transfers,
1668                      (unsigned long)drv_data);
1669
1670         pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
1671         pm_runtime_use_autosuspend(&pdev->dev);
1672         pm_runtime_set_active(&pdev->dev);
1673         pm_runtime_enable(&pdev->dev);
1674
1675         /* Register with the SPI framework */
1676         platform_set_drvdata(pdev, drv_data);
1677         status = devm_spi_register_master(&pdev->dev, master);
1678         if (status != 0) {
1679                 dev_err(&pdev->dev, "problem registering spi master\n");
1680                 goto out_error_clock_enabled;
1681         }
1682
1683         return status;
1684
1685 out_error_clock_enabled:
1686         clk_disable_unprepare(ssp->clk);
1687         pxa2xx_spi_dma_release(drv_data);
1688         free_irq(ssp->irq, drv_data);
1689
1690 out_error_master_alloc:
1691         spi_master_put(master);
1692         pxa_ssp_free(ssp);
1693         return status;
1694 }
1695
1696 static int pxa2xx_spi_remove(struct platform_device *pdev)
1697 {
1698         struct driver_data *drv_data = platform_get_drvdata(pdev);
1699         struct ssp_device *ssp;
1700
1701         if (!drv_data)
1702                 return 0;
1703         ssp = drv_data->ssp;
1704
1705         pm_runtime_get_sync(&pdev->dev);
1706
1707         /* Disable the SSP at the peripheral and SOC level */
1708         pxa2xx_spi_write(drv_data, SSCR0, 0);
1709         clk_disable_unprepare(ssp->clk);
1710
1711         /* Release DMA */
1712         if (drv_data->master_info->enable_dma)
1713                 pxa2xx_spi_dma_release(drv_data);
1714
1715         pm_runtime_put_noidle(&pdev->dev);
1716         pm_runtime_disable(&pdev->dev);
1717
1718         /* Release IRQ */
1719         free_irq(ssp->irq, drv_data);
1720
1721         /* Release SSP */
1722         pxa_ssp_free(ssp);
1723
1724         return 0;
1725 }
1726
1727 static void pxa2xx_spi_shutdown(struct platform_device *pdev)
1728 {
1729         int status = 0;
1730
1731         if ((status = pxa2xx_spi_remove(pdev)) != 0)
1732                 dev_err(&pdev->dev, "shutdown failed with %d\n", status);
1733 }
1734
1735 #ifdef CONFIG_PM_SLEEP
1736 static int pxa2xx_spi_suspend(struct device *dev)
1737 {
1738         struct driver_data *drv_data = dev_get_drvdata(dev);
1739         struct ssp_device *ssp = drv_data->ssp;
1740         int status;
1741
1742         status = spi_master_suspend(drv_data->master);
1743         if (status != 0)
1744                 return status;
1745         pxa2xx_spi_write(drv_data, SSCR0, 0);
1746
1747         if (!pm_runtime_suspended(dev))
1748                 clk_disable_unprepare(ssp->clk);
1749
1750         return 0;
1751 }
1752
1753 static int pxa2xx_spi_resume(struct device *dev)
1754 {
1755         struct driver_data *drv_data = dev_get_drvdata(dev);
1756         struct ssp_device *ssp = drv_data->ssp;
1757         int status;
1758
1759         /* Enable the SSP clock */
1760         if (!pm_runtime_suspended(dev))
1761                 clk_prepare_enable(ssp->clk);
1762
1763         /* Restore LPSS private register bits */
1764         if (is_lpss_ssp(drv_data))
1765                 lpss_ssp_setup(drv_data);
1766
1767         /* Start the queue running */
1768         status = spi_master_resume(drv_data->master);
1769         if (status != 0) {
1770                 dev_err(dev, "problem starting queue (%d)\n", status);
1771                 return status;
1772         }
1773
1774         return 0;
1775 }
1776 #endif
1777
1778 #ifdef CONFIG_PM
1779 static int pxa2xx_spi_runtime_suspend(struct device *dev)
1780 {
1781         struct driver_data *drv_data = dev_get_drvdata(dev);
1782
1783         clk_disable_unprepare(drv_data->ssp->clk);
1784         return 0;
1785 }
1786
1787 static int pxa2xx_spi_runtime_resume(struct device *dev)
1788 {
1789         struct driver_data *drv_data = dev_get_drvdata(dev);
1790
1791         clk_prepare_enable(drv_data->ssp->clk);
1792         return 0;
1793 }
1794 #endif
1795
1796 static const struct dev_pm_ops pxa2xx_spi_pm_ops = {
1797         SET_SYSTEM_SLEEP_PM_OPS(pxa2xx_spi_suspend, pxa2xx_spi_resume)
1798         SET_RUNTIME_PM_OPS(pxa2xx_spi_runtime_suspend,
1799                            pxa2xx_spi_runtime_resume, NULL)
1800 };
1801
1802 static struct platform_driver driver = {
1803         .driver = {
1804                 .name   = "pxa2xx-spi",
1805                 .pm     = &pxa2xx_spi_pm_ops,
1806                 .acpi_match_table = ACPI_PTR(pxa2xx_spi_acpi_match),
1807         },
1808         .probe = pxa2xx_spi_probe,
1809         .remove = pxa2xx_spi_remove,
1810         .shutdown = pxa2xx_spi_shutdown,
1811 };
1812
1813 static int __init pxa2xx_spi_init(void)
1814 {
1815         return platform_driver_register(&driver);
1816 }
1817 subsys_initcall(pxa2xx_spi_init);
1818
1819 static void __exit pxa2xx_spi_exit(void)
1820 {
1821         platform_driver_unregister(&driver);
1822 }
1823 module_exit(pxa2xx_spi_exit);