drivers/spi/spi-fsl-spi.c

   1 /*
   2  * Freescale SPI controller driver.
   3  *
   4  * Maintainer: Kumar Gala
   5  *
   6  * Copyright (C) 2006 Polycom, Inc.
   7  * Copyright 2010 Freescale Semiconductor, Inc.
   8  *
   9  * CPM SPI and QE buffer descriptors mode support:
  10  * Copyright (c) 2009  MontaVista Software, Inc.
  11  * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
  12  *
  13  * GRLIB support:
  14  * Copyright (c) 2012 Aeroflex Gaisler AB.
  15  * Author: Andreas Larsson <andreas@gaisler.com>
  16  *
  17  * This program is free software; you can redistribute  it and/or modify it
  18  * under  the terms of  the GNU General  Public License as published by the
  19  * Free Software Foundation;  either version 2 of the  License, or (at your
  20  * option) any later version.
  21  */
  22 #include <linux/delay.h>
  23 #include <linux/dma-mapping.h>
  24 #include <linux/fsl_devices.h>
  25 #include <linux/gpio.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/irq.h>
  28 #include <linux/kernel.h>
  29 #include <linux/mm.h>
  30 #include <linux/module.h>
  31 #include <linux/mutex.h>
  32 #include <linux/of.h>
  33 #include <linux/of_address.h>
  34 #include <linux/of_irq.h>
  35 #include <linux/of_gpio.h>
  36 #include <linux/of_platform.h>
  37 #include <linux/platform_device.h>
  38 #include <linux/spi/spi.h>
  39 #include <linux/spi/spi_bitbang.h>
  40 #include <linux/types.h>
  41
  42 #include "spi-fsl-lib.h"
  43 #include "spi-fsl-cpm.h"
  44 #include "spi-fsl-spi.h"
  45
  46 #define TYPE_FSL        0
  47 #define TYPE_GRLIB      1
  48
  49 struct fsl_spi_match_data {
  50         int type;
  51 };
  52
  53 static struct fsl_spi_match_data of_fsl_spi_fsl_config = {
  54         .type = TYPE_FSL,
  55 };
  56
  57 static struct fsl_spi_match_data of_fsl_spi_grlib_config = {
  58         .type = TYPE_GRLIB,
  59 };
  60
  61 static const struct of_device_id of_fsl_spi_match[] = {
  62         {
  63                 .compatible = "fsl,spi",
  64                 .data = &of_fsl_spi_fsl_config,
  65         },
  66         {
  67                 .compatible = "aeroflexgaisler,spictrl",
  68                 .data = &of_fsl_spi_grlib_config,
  69         },
  70         {}
  71 };
  72 MODULE_DEVICE_TABLE(of, of_fsl_spi_match);
  73
  74 static int fsl_spi_get_type(struct device *dev)
  75 {
  76         const struct of_device_id *match;
  77
  78         if (dev->of_node) {
  79                 match = of_match_node(of_fsl_spi_match, dev->of_node);
  80                 if (match && match->data)
  81                         return ((struct fsl_spi_match_data *)match->data)->type;
  82         }
  83         return TYPE_FSL;
  84 }
  85
  86 static void fsl_spi_change_mode(struct spi_device *spi)
  87 {
  88         struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
  89         struct spi_mpc8xxx_cs *cs = spi->controller_state;
  90         struct fsl_spi_reg *reg_base = mspi->reg_base;
  91         __be32 __iomem *mode = &reg_base->mode;
  92         unsigned long flags;
  93
  94         if (cs->hw_mode == mpc8xxx_spi_read_reg(mode))
  95                 return;
  96
  97         /* Turn off IRQs locally to minimize time that SPI is disabled. */
  98         local_irq_save(flags);
  99
 100         /* Turn off SPI unit prior changing mode */
 101         mpc8xxx_spi_write_reg(mode, cs->hw_mode & ~SPMODE_ENABLE);
 102
 103         /* When in CPM mode, we need to reinit tx and rx. */
 104         if (mspi->flags & SPI_CPM_MODE) {
 105                 fsl_spi_cpm_reinit_txrx(mspi);
 106         }
 107         mpc8xxx_spi_write_reg(mode, cs->hw_mode);
 108         local_irq_restore(flags);
 109 }
 110
 111 static void fsl_spi_chipselect(struct spi_device *spi, int value)
 112 {
 113         struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
 114         struct fsl_spi_platform_data *pdata;
 115         bool pol = spi->mode & SPI_CS_HIGH;
 116         struct spi_mpc8xxx_cs   *cs = spi->controller_state;
 117
 118         pdata = spi->dev.parent->parent->platform_data;
 119
 120         if (value == BITBANG_CS_INACTIVE) {
 121                 if (pdata->cs_control)
 122                         pdata->cs_control(spi, !pol);
 123         }
 124
 125         if (value == BITBANG_CS_ACTIVE) {
 126                 mpc8xxx_spi->rx_shift = cs->rx_shift;
 127                 mpc8xxx_spi->tx_shift = cs->tx_shift;
 128                 mpc8xxx_spi->get_rx = cs->get_rx;
 129                 mpc8xxx_spi->get_tx = cs->get_tx;
 130
 131                 fsl_spi_change_mode(spi);
 132
 133                 if (pdata->cs_control)
 134                         pdata->cs_control(spi, pol);
 135         }
 136 }
 137
 138 static void fsl_spi_qe_cpu_set_shifts(u32 *rx_shift, u32 *tx_shift,
 139                                       int bits_per_word, int msb_first)
 140 {
 141         *rx_shift = 0;
 142         *tx_shift = 0;
 143         if (msb_first) {
 144                 if (bits_per_word <= 8) {
 145                         *rx_shift = 16;
 146                         *tx_shift = 24;
 147                 } else if (bits_per_word <= 16) {
 148                         *rx_shift = 16;
 149                         *tx_shift = 16;
 150                 }
 151         } else {
 152                 if (bits_per_word <= 8)
 153                         *rx_shift = 8;
 154         }
 155 }
 156
 157 static void fsl_spi_grlib_set_shifts(u32 *rx_shift, u32 *tx_shift,
 158                                      int bits_per_word, int msb_first)
 159 {
 160         *rx_shift = 0;
 161         *tx_shift = 0;
 162         if (bits_per_word <= 16) {
 163                 if (msb_first) {
 164                         *rx_shift = 16; /* LSB in bit 16 */
 165                         *tx_shift = 32 - bits_per_word; /* MSB in bit 31 */
 166                 } else {
 167                         *rx_shift = 16 - bits_per_word; /* MSB in bit 15 */
 168                 }
 169         }
 170 }
 171
 172 static int mspi_apply_cpu_mode_quirks(struct spi_mpc8xxx_cs *cs,
 173                                 struct spi_device *spi,
 174                                 struct mpc8xxx_spi *mpc8xxx_spi,
 175                                 int bits_per_word)
 176 {
 177         cs->rx_shift = 0;
 178         cs->tx_shift = 0;
 179         if (bits_per_word <= 8) {
 180                 cs->get_rx = mpc8xxx_spi_rx_buf_u8;
 181                 cs->get_tx = mpc8xxx_spi_tx_buf_u8;
 182         } else if (bits_per_word <= 16) {
 183                 cs->get_rx = mpc8xxx_spi_rx_buf_u16;
 184                 cs->get_tx = mpc8xxx_spi_tx_buf_u16;
 185         } else if (bits_per_word <= 32) {
 186                 cs->get_rx = mpc8xxx_spi_rx_buf_u32;
 187                 cs->get_tx = mpc8xxx_spi_tx_buf_u32;
 188         } else
 189                 return -EINVAL;
 190
 191         if (mpc8xxx_spi->set_shifts)
 192                 mpc8xxx_spi->set_shifts(&cs->rx_shift, &cs->tx_shift,
 193                                         bits_per_word,
 194                                         !(spi->mode & SPI_LSB_FIRST));
 195
 196         mpc8xxx_spi->rx_shift = cs->rx_shift;
 197         mpc8xxx_spi->tx_shift = cs->tx_shift;
 198         mpc8xxx_spi->get_rx = cs->get_rx;
 199         mpc8xxx_spi->get_tx = cs->get_tx;
 200
 201         return bits_per_word;
 202 }
 203
 204 static int mspi_apply_qe_mode_quirks(struct spi_mpc8xxx_cs *cs,
 205                                 struct spi_device *spi,
 206                                 int bits_per_word)
 207 {
 208         /* QE uses Little Endian for words > 8
 209          * so transform all words > 8 into 8 bits
 210          * Unfortnatly that doesn't work for LSB so
 211          * reject these for now */
 212         /* Note: 32 bits word, LSB works iff
 213          * tfcr/rfcr is set to CPMFCR_GBL */
 214         if (spi->mode & SPI_LSB_FIRST &&
 215             bits_per_word > 8)
 216                 return -EINVAL;
 217         if (bits_per_word > 8)
 218                 return 8; /* pretend its 8 bits */
 219         return bits_per_word;
 220 }
 221
 222 static int fsl_spi_setup_transfer(struct spi_device *spi,
 223                                         struct spi_transfer *t)
 224 {
 225         struct mpc8xxx_spi *mpc8xxx_spi;
 226         int bits_per_word = 0;
 227         u8 pm;
 228         u32 hz = 0;
 229         struct spi_mpc8xxx_cs   *cs = spi->controller_state;
 230
 231         mpc8xxx_spi = spi_master_get_devdata(spi->master);
 232
 233         if (t) {
 234                 bits_per_word = t->bits_per_word;
 235                 hz = t->speed_hz;
 236         }
 237
 238         /* spi_transfer level calls that work per-word */
 239         if (!bits_per_word)
 240                 bits_per_word = spi->bits_per_word;
 241
 242         if (!hz)
 243                 hz = spi->max_speed_hz;
 244
 245         if (!(mpc8xxx_spi->flags & SPI_CPM_MODE))
 246                 bits_per_word = mspi_apply_cpu_mode_quirks(cs, spi,
 247                                                            mpc8xxx_spi,
 248                                                            bits_per_word);
 249         else if (mpc8xxx_spi->flags & SPI_QE)
 250                 bits_per_word = mspi_apply_qe_mode_quirks(cs, spi,
 251                                                           bits_per_word);
 252
 253         if (bits_per_word < 0)
 254                 return bits_per_word;
 255
 256         if (bits_per_word == 32)
 257                 bits_per_word = 0;
 258         else
 259                 bits_per_word = bits_per_word - 1;
 260
 261         /* mask out bits we are going to set */
 262         cs->hw_mode &= ~(SPMODE_LEN(0xF) | SPMODE_DIV16
 263                                   | SPMODE_PM(0xF));
 264
 265         cs->hw_mode |= SPMODE_LEN(bits_per_word);
 266
 267         if ((mpc8xxx_spi->spibrg / hz) > 64) {
 268                 cs->hw_mode |= SPMODE_DIV16;
 269                 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 64) + 1;
 270
 271                 WARN_ONCE(pm > 16, "%s: Requested speed is too low: %d Hz. "
 272                           "Will use %d Hz instead.\n", dev_name(&spi->dev),
 273                           hz, mpc8xxx_spi->spibrg / 1024);
 274                 if (pm > 16)
 275                         pm = 16;
 276         } else {
 277                 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 4) + 1;
 278         }
 279         if (pm)
 280                 pm--;
 281
 282         cs->hw_mode |= SPMODE_PM(pm);
 283
 284         fsl_spi_change_mode(spi);
 285         return 0;
 286 }
 287
 288 static int fsl_spi_cpu_bufs(struct mpc8xxx_spi *mspi,
 289                                 struct spi_transfer *t, unsigned int len)
 290 {
 291         u32 word;
 292         struct fsl_spi_reg *reg_base = mspi->reg_base;
 293
 294         mspi->count = len;
 295
 296         /* enable rx ints */
 297         mpc8xxx_spi_write_reg(&reg_base->mask, SPIM_NE);
 298
 299         /* transmit word */
 300         word = mspi->get_tx(mspi);
 301         mpc8xxx_spi_write_reg(&reg_base->transmit, word);
 302
 303         return 0;
 304 }
 305
 306 static int fsl_spi_bufs(struct spi_device *spi, struct spi_transfer *t,
 307                             bool is_dma_mapped)
 308 {
 309         struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
 310         struct fsl_spi_reg *reg_base;
 311         unsigned int len = t->len;
 312         u8 bits_per_word;
 313         int ret;
 314
 315         reg_base = mpc8xxx_spi->reg_base;
 316         bits_per_word = spi->bits_per_word;
 317         if (t->bits_per_word)
 318                 bits_per_word = t->bits_per_word;
 319
 320         if (bits_per_word > 8) {
 321                 /* invalid length? */
 322                 if (len & 1)
 323                         return -EINVAL;
 324                 len /= 2;
 325         }
 326         if (bits_per_word > 16) {
 327                 /* invalid length? */
 328                 if (len & 1)
 329                         return -EINVAL;
 330                 len /= 2;
 331         }
 332
 333         mpc8xxx_spi->tx = t->tx_buf;
 334         mpc8xxx_spi->rx = t->rx_buf;
 335
 336         reinit_completion(&mpc8xxx_spi->done);
 337
 338         if (mpc8xxx_spi->flags & SPI_CPM_MODE)
 339                 ret = fsl_spi_cpm_bufs(mpc8xxx_spi, t, is_dma_mapped);
 340         else
 341                 ret = fsl_spi_cpu_bufs(mpc8xxx_spi, t, len);
 342         if (ret)
 343                 return ret;
 344
 345         wait_for_completion(&mpc8xxx_spi->done);
 346
 347         /* disable rx ints */
 348         mpc8xxx_spi_write_reg(&reg_base->mask, 0);
 349
 350         if (mpc8xxx_spi->flags & SPI_CPM_MODE)
 351                 fsl_spi_cpm_bufs_complete(mpc8xxx_spi);
 352
 353         return mpc8xxx_spi->count;
 354 }
 355
 356 static int fsl_spi_do_one_msg(struct spi_master *master,
 357                               struct spi_message *m)
 358 {
 359         struct spi_device *spi = m->spi;
 360         struct spi_transfer *t, *first;
 361         unsigned int cs_change;
 362         const int nsecs = 50;
 363         int status;
 364
 365         /* Don't allow changes if CS is active */
 366         first = list_first_entry(&m->transfers, struct spi_transfer,
 367                         transfer_list);
 368         list_for_each_entry(t, &m->transfers, transfer_list) {
 369                 if ((first->bits_per_word != t->bits_per_word) ||
 370                         (first->speed_hz != t->speed_hz)) {
 371                         status = -EINVAL;
 372                         dev_err(&spi->dev,
 373                                 "bits_per_word/speed_hz should be same for the same SPI transfer\n");
 374                         return -EINVAL;
 375                 }
 376         }
 377
 378         cs_change = 1;
 379         status = -EINVAL;
 380         list_for_each_entry(t, &m->transfers, transfer_list) {
 381                 if (t->bits_per_word || t->speed_hz) {
 382                         if (cs_change)
 383                                 status = fsl_spi_setup_transfer(spi, t);
 384                         if (status < 0)
 385                                 break;
 386                 }
 387
 388                 if (cs_change) {
 389                         fsl_spi_chipselect(spi, BITBANG_CS_ACTIVE);
 390                         ndelay(nsecs);
 391                 }
 392                 cs_change = t->cs_change;
 393                 if (t->len)
 394                         status = fsl_spi_bufs(spi, t, m->is_dma_mapped);
 395                 if (status) {
 396                         status = -EMSGSIZE;
 397                         break;
 398                 }
 399                 m->actual_length += t->len;
 400
 401                 if (t->delay_usecs)
 402                         udelay(t->delay_usecs);
 403
 404                 if (cs_change) {
 405                         ndelay(nsecs);
 406                         fsl_spi_chipselect(spi, BITBANG_CS_INACTIVE);
 407                         ndelay(nsecs);
 408                 }
 409         }
 410
 411         m->status = status;
 412         spi_finalize_current_message(master);
 413
 414         if (status || !cs_change) {
 415                 ndelay(nsecs);
 416                 fsl_spi_chipselect(spi, BITBANG_CS_INACTIVE);
 417         }
 418
 419         fsl_spi_setup_transfer(spi, NULL);
 420         return 0;
 421 }
 422
 423 static int fsl_spi_setup(struct spi_device *spi)
 424 {
 425         struct mpc8xxx_spi *mpc8xxx_spi;
 426         struct fsl_spi_reg *reg_base;
 427         int retval;
 428         u32 hw_mode;
 429         struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
 430
 431         if (!spi->max_speed_hz)
 432                 return -EINVAL;
 433
 434         if (!cs) {
 435                 cs = kzalloc(sizeof(*cs), GFP_KERNEL);
 436                 if (!cs)
 437                         return -ENOMEM;
 438                 spi_set_ctldata(spi, cs);
 439         }
 440         mpc8xxx_spi = spi_master_get_devdata(spi->master);
 441
 442         reg_base = mpc8xxx_spi->reg_base;
 443
 444         hw_mode = cs->hw_mode; /* Save original settings */
 445         cs->hw_mode = mpc8xxx_spi_read_reg(&reg_base->mode);
 446         /* mask out bits we are going to set */
 447         cs->hw_mode &= ~(SPMODE_CP_BEGIN_EDGECLK | SPMODE_CI_INACTIVEHIGH
 448                          | SPMODE_REV | SPMODE_LOOP);
 449
 450         if (spi->mode & SPI_CPHA)
 451                 cs->hw_mode |= SPMODE_CP_BEGIN_EDGECLK;
 452         if (spi->mode & SPI_CPOL)
 453                 cs->hw_mode |= SPMODE_CI_INACTIVEHIGH;
 454         if (!(spi->mode & SPI_LSB_FIRST))
 455                 cs->hw_mode |= SPMODE_REV;
 456         if (spi->mode & SPI_LOOP)
 457                 cs->hw_mode |= SPMODE_LOOP;
 458
 459         retval = fsl_spi_setup_transfer(spi, NULL);
 460         if (retval < 0) {
 461                 cs->hw_mode = hw_mode; /* Restore settings */
 462                 return retval;
 463         }
 464
 465         if (mpc8xxx_spi->type == TYPE_GRLIB) {
 466                 if (gpio_is_valid(spi->cs_gpio)) {
 467                         int desel;
 468
 469                         retval = gpio_request(spi->cs_gpio,
 470                                               dev_name(&spi->dev));
 471                         if (retval)
 472                                 return retval;
 473
 474                         desel = !(spi->mode & SPI_CS_HIGH);
 475                         retval = gpio_direction_output(spi->cs_gpio, desel);
 476                         if (retval) {
 477                                 gpio_free(spi->cs_gpio);
 478                                 return retval;
 479                         }
 480                 } else if (spi->cs_gpio != -ENOENT) {
 481                         if (spi->cs_gpio < 0)
 482                                 return spi->cs_gpio;
 483                         return -EINVAL;
 484                 }
 485                 /* When spi->cs_gpio == -ENOENT, a hole in the phandle list
 486                  * indicates to use native chipselect if present, or allow for
 487                  * an always selected chip
 488                  */
 489         }
 490
 491         /* Initialize chipselect - might be active for SPI_CS_HIGH mode */
 492         fsl_spi_chipselect(spi, BITBANG_CS_INACTIVE);
 493
 494         return 0;
 495 }
 496
 497 static void fsl_spi_cleanup(struct spi_device *spi)
 498 {
 499         struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
 500         struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
 501
 502         if (mpc8xxx_spi->type == TYPE_GRLIB && gpio_is_valid(spi->cs_gpio))
 503                 gpio_free(spi->cs_gpio);
 504
 505         kfree(cs);
 506         spi_set_ctldata(spi, NULL);
 507 }
 508
 509 static void fsl_spi_cpu_irq(struct mpc8xxx_spi *mspi, u32 events)
 510 {
 511         struct fsl_spi_reg *reg_base = mspi->reg_base;
 512
 513         /* We need handle RX first */
 514         if (events & SPIE_NE) {
 515                 u32 rx_data = mpc8xxx_spi_read_reg(&reg_base->receive);
 516
 517                 if (mspi->rx)
 518                         mspi->get_rx(rx_data, mspi);
 519         }
 520
 521         if ((events & SPIE_NF) == 0)
 522                 /* spin until TX is done */
 523                 while (((events =
 524                         mpc8xxx_spi_read_reg(&reg_base->event)) &
 525                                                 SPIE_NF) == 0)
 526                         cpu_relax();
 527
 528         /* Clear the events */
 529         mpc8xxx_spi_write_reg(&reg_base->event, events);
 530
 531         mspi->count -= 1;
 532         if (mspi->count) {
 533                 u32 word = mspi->get_tx(mspi);
 534
 535                 mpc8xxx_spi_write_reg(&reg_base->transmit, word);
 536         } else {
 537                 complete(&mspi->done);
 538         }
 539 }
 540
 541 static irqreturn_t fsl_spi_irq(s32 irq, void *context_data)
 542 {
 543         struct mpc8xxx_spi *mspi = context_data;
 544         irqreturn_t ret = IRQ_NONE;
 545         u32 events;
 546         struct fsl_spi_reg *reg_base = mspi->reg_base;
 547
 548         /* Get interrupt events(tx/rx) */
 549         events = mpc8xxx_spi_read_reg(&reg_base->event);
 550         if (events)
 551                 ret = IRQ_HANDLED;
 552
 553         dev_dbg(mspi->dev, "%s: events %x\n", __func__, events);
 554
 555         if (mspi->flags & SPI_CPM_MODE)
 556                 fsl_spi_cpm_irq(mspi, events);
 557         else
 558                 fsl_spi_cpu_irq(mspi, events);
 559
 560         return ret;
 561 }
 562
 563 static void fsl_spi_remove(struct mpc8xxx_spi *mspi)
 564 {
 565         iounmap(mspi->reg_base);
 566         fsl_spi_cpm_free(mspi);
 567 }
 568
 569 static void fsl_spi_grlib_cs_control(struct spi_device *spi, bool on)
 570 {
 571         struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
 572         struct fsl_spi_reg *reg_base = mpc8xxx_spi->reg_base;
 573         u32 slvsel;
 574         u16 cs = spi->chip_select;
 575
 576         if (gpio_is_valid(spi->cs_gpio)) {
 577                 gpio_set_value(spi->cs_gpio, on);
 578         } else if (cs < mpc8xxx_spi->native_chipselects) {
 579                 slvsel = mpc8xxx_spi_read_reg(&reg_base->slvsel);
 580                 slvsel = on ? (slvsel | (1 << cs)) : (slvsel & ~(1 << cs));
 581                 mpc8xxx_spi_write_reg(&reg_base->slvsel, slvsel);
 582         }
 583 }
 584
 585 static void fsl_spi_grlib_probe(struct device *dev)
 586 {
 587         struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
 588         struct spi_master *master = dev_get_drvdata(dev);
 589         struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
 590         struct fsl_spi_reg *reg_base = mpc8xxx_spi->reg_base;
 591         int mbits;
 592         u32 capabilities;
 593
 594         capabilities = mpc8xxx_spi_read_reg(&reg_base->cap);
 595
 596         mpc8xxx_spi->set_shifts = fsl_spi_grlib_set_shifts;
 597         mbits = SPCAP_MAXWLEN(capabilities);
 598         if (mbits)
 599                 mpc8xxx_spi->max_bits_per_word = mbits + 1;
 600
 601         mpc8xxx_spi->native_chipselects = 0;
 602         if (SPCAP_SSEN(capabilities)) {
 603                 mpc8xxx_spi->native_chipselects = SPCAP_SSSZ(capabilities);
 604                 mpc8xxx_spi_write_reg(&reg_base->slvsel, 0xffffffff);
 605         }
 606         master->num_chipselect = mpc8xxx_spi->native_chipselects;
 607         pdata->cs_control = fsl_spi_grlib_cs_control;
 608 }
 609
 610 static struct spi_master * fsl_spi_probe(struct device *dev,
 611                 struct resource *mem, unsigned int irq)
 612 {
 613         struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
 614         struct spi_master *master;
 615         struct mpc8xxx_spi *mpc8xxx_spi;
 616         struct fsl_spi_reg *reg_base;
 617         u32 regval;
 618         int ret = 0;
 619
 620         master = spi_alloc_master(dev, sizeof(struct mpc8xxx_spi));
 621         if (master == NULL) {
 622                 ret = -ENOMEM;
 623                 goto err;
 624         }
 625
 626         dev_set_drvdata(dev, master);
 627
 628         mpc8xxx_spi_probe(dev, mem, irq);
 629
 630         master->setup = fsl_spi_setup;
 631         master->cleanup = fsl_spi_cleanup;
 632         master->transfer_one_message = fsl_spi_do_one_msg;
 633
 634         mpc8xxx_spi = spi_master_get_devdata(master);
 635         mpc8xxx_spi->spi_remove = fsl_spi_remove;
 636         mpc8xxx_spi->max_bits_per_word = 32;
 637         mpc8xxx_spi->type = fsl_spi_get_type(dev);
 638
 639         ret = fsl_spi_cpm_init(mpc8xxx_spi);
 640         if (ret)
 641                 goto err_cpm_init;
 642
 643         mpc8xxx_spi->reg_base = ioremap(mem->start, resource_size(mem));
 644         if (mpc8xxx_spi->reg_base == NULL) {
 645                 ret = -ENOMEM;
 646                 goto err_ioremap;
 647         }
 648
 649         if (mpc8xxx_spi->type == TYPE_GRLIB)
 650                 fsl_spi_grlib_probe(dev);
 651
 652         master->bits_per_word_mask =
 653                 (SPI_BPW_RANGE_MASK(4, 16) | SPI_BPW_MASK(32)) &
 654                 SPI_BPW_RANGE_MASK(1, mpc8xxx_spi->max_bits_per_word);
 655
 656         if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE)
 657                 mpc8xxx_spi->set_shifts = fsl_spi_qe_cpu_set_shifts;
 658
 659         if (mpc8xxx_spi->set_shifts)
 660                 /* 8 bits per word and MSB first */
 661                 mpc8xxx_spi->set_shifts(&mpc8xxx_spi->rx_shift,
 662                                         &mpc8xxx_spi->tx_shift, 8, 1);
 663
 664         /* Register for SPI Interrupt */
 665         ret = request_irq(mpc8xxx_spi->irq, fsl_spi_irq,
 666                           0, "fsl_spi", mpc8xxx_spi);
 667
 668         if (ret != 0)
 669                 goto free_irq;
 670
 671         reg_base = mpc8xxx_spi->reg_base;
 672
 673         /* SPI controller initializations */
 674         mpc8xxx_spi_write_reg(&reg_base->mode, 0);
 675         mpc8xxx_spi_write_reg(&reg_base->mask, 0);
 676         mpc8xxx_spi_write_reg(&reg_base->command, 0);
 677         mpc8xxx_spi_write_reg(&reg_base->event, 0xffffffff);
 678
 679         /* Enable SPI interface */
 680         regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
 681         if (mpc8xxx_spi->max_bits_per_word < 8) {
 682                 regval &= ~SPMODE_LEN(0xF);
 683                 regval |= SPMODE_LEN(mpc8xxx_spi->max_bits_per_word - 1);
 684         }
 685         if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE)
 686                 regval |= SPMODE_OP;
 687
 688         mpc8xxx_spi_write_reg(&reg_base->mode, regval);
 689
 690         ret = spi_register_master(master);
 691         if (ret < 0)
 692                 goto unreg_master;
 693
 694         dev_info(dev, "at 0x%p (irq = %d), %s mode\n", reg_base,
 695                  mpc8xxx_spi->irq, mpc8xxx_spi_strmode(mpc8xxx_spi->flags));
 696
 697         return master;
 698
 699 unreg_master:
 700         free_irq(mpc8xxx_spi->irq, mpc8xxx_spi);
 701 free_irq:
 702         iounmap(mpc8xxx_spi->reg_base);
 703 err_ioremap:
 704         fsl_spi_cpm_free(mpc8xxx_spi);
 705 err_cpm_init:
 706         spi_master_put(master);
 707 err:
 708         return ERR_PTR(ret);
 709 }
 710
 711 static void fsl_spi_cs_control(struct spi_device *spi, bool on)
 712 {
 713         struct device *dev = spi->dev.parent->parent;
 714         struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
 715         struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
 716         u16 cs = spi->chip_select;
 717         int gpio = pinfo->gpios[cs];
 718         bool alow = pinfo->alow_flags[cs];
 719
 720         gpio_set_value(gpio, on ^ alow);
 721 }
 722
 723 static int of_fsl_spi_get_chipselects(struct device *dev)
 724 {
 725         struct device_node *np = dev->of_node;
 726         struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
 727         struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
 728         int ngpios;
 729         int i = 0;
 730         int ret;
 731
 732         ngpios = of_gpio_count(np);
 733         if (ngpios <= 0) {
 734                 /*
 735                  * SPI w/o chip-select line. One SPI device is still permitted
 736                  * though.
 737                  */
 738                 pdata->max_chipselect = 1;
 739                 return 0;
 740         }
 741
 742         pinfo->gpios = kmalloc(ngpios * sizeof(*pinfo->gpios), GFP_KERNEL);
 743         if (!pinfo->gpios)
 744                 return -ENOMEM;
 745         memset(pinfo->gpios, -1, ngpios * sizeof(*pinfo->gpios));
 746
 747         pinfo->alow_flags = kzalloc(ngpios * sizeof(*pinfo->alow_flags),
 748                                     GFP_KERNEL);
 749         if (!pinfo->alow_flags) {
 750                 ret = -ENOMEM;
 751                 goto err_alloc_flags;
 752         }
 753
 754         for (; i < ngpios; i++) {
 755                 int gpio;
 756                 enum of_gpio_flags flags;
 757
 758                 gpio = of_get_gpio_flags(np, i, &flags);
 759                 if (!gpio_is_valid(gpio)) {
 760                         dev_err(dev, "invalid gpio #%d: %d\n", i, gpio);
 761                         ret = gpio;
 762                         goto err_loop;
 763                 }
 764
 765                 ret = gpio_request(gpio, dev_name(dev));
 766                 if (ret) {
 767                         dev_err(dev, "can't request gpio #%d: %d\n", i, ret);
 768                         goto err_loop;
 769                 }
 770
 771                 pinfo->gpios[i] = gpio;
 772                 pinfo->alow_flags[i] = flags & OF_GPIO_ACTIVE_LOW;
 773
 774                 ret = gpio_direction_output(pinfo->gpios[i],
 775                                             pinfo->alow_flags[i]);
 776                 if (ret) {
 777                         dev_err(dev, "can't set output direction for gpio "
 778                                 "#%d: %d\n", i, ret);
 779                         goto err_loop;
 780                 }
 781         }
 782
 783         pdata->max_chipselect = ngpios;
 784         pdata->cs_control = fsl_spi_cs_control;
 785
 786         return 0;
 787
 788 err_loop:
 789         while (i >= 0) {
 790                 if (gpio_is_valid(pinfo->gpios[i]))
 791                         gpio_free(pinfo->gpios[i]);
 792                 i--;
 793         }
 794
 795         kfree(pinfo->alow_flags);
 796         pinfo->alow_flags = NULL;
 797 err_alloc_flags:
 798         kfree(pinfo->gpios);
 799         pinfo->gpios = NULL;
 800         return ret;
 801 }
 802
 803 static int of_fsl_spi_free_chipselects(struct device *dev)
 804 {
 805         struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
 806         struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
 807         int i;
 808
 809         if (!pinfo->gpios)
 810                 return 0;
 811
 812         for (i = 0; i < pdata->max_chipselect; i++) {
 813                 if (gpio_is_valid(pinfo->gpios[i]))
 814                         gpio_free(pinfo->gpios[i]);
 815         }
 816
 817         kfree(pinfo->gpios);
 818         kfree(pinfo->alow_flags);
 819         return 0;
 820 }
 821
 822 static int of_fsl_spi_probe(struct platform_device *ofdev)
 823 {
 824         struct device *dev = &ofdev->dev;
 825         struct device_node *np = ofdev->dev.of_node;
 826         struct spi_master *master;
 827         struct resource mem;
 828         int irq, type;
 829         int ret = -ENOMEM;
 830
 831         ret = of_mpc8xxx_spi_probe(ofdev);
 832         if (ret)
 833                 return ret;
 834
 835         type = fsl_spi_get_type(&ofdev->dev);
 836         if (type == TYPE_FSL) {
 837                 ret = of_fsl_spi_get_chipselects(dev);
 838                 if (ret)
 839                         goto err;
 840         }
 841
 842         ret = of_address_to_resource(np, 0, &mem);
 843         if (ret)
 844                 goto err;
 845
 846         irq = irq_of_parse_and_map(np, 0);
 847         if (!irq) {
 848                 ret = -EINVAL;
 849                 goto err;
 850         }
 851
 852         master = fsl_spi_probe(dev, &mem, irq);
 853         if (IS_ERR(master)) {
 854                 ret = PTR_ERR(master);
 855                 goto err;
 856         }
 857
 858         return 0;
 859
 860 err:
 861         if (type == TYPE_FSL)
 862                 of_fsl_spi_free_chipselects(dev);
 863         return ret;
 864 }
 865
 866 static int of_fsl_spi_remove(struct platform_device *ofdev)
 867 {
 868         struct spi_master *master = platform_get_drvdata(ofdev);
 869         struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
 870         int ret;
 871
 872         ret = mpc8xxx_spi_remove(&ofdev->dev);
 873         if (ret)
 874                 return ret;
 875         if (mpc8xxx_spi->type == TYPE_FSL)
 876                 of_fsl_spi_free_chipselects(&ofdev->dev);
 877         return 0;
 878 }
 879
 880 static struct platform_driver of_fsl_spi_driver = {
 881         .driver = {
 882                 .name = "fsl_spi",
 883                 .owner = THIS_MODULE,
 884                 .of_match_table = of_fsl_spi_match,
 885         },
 886         .probe          = of_fsl_spi_probe,
 887         .remove         = of_fsl_spi_remove,
 888 };
 889
 890 #ifdef CONFIG_MPC832x_RDB
 891 /*
 892  * XXX XXX XXX
 893  * This is "legacy" platform driver, was used by the MPC8323E-RDB boards
 894  * only. The driver should go away soon, since newer MPC8323E-RDB's device
 895  * tree can work with OpenFirmware driver. But for now we support old trees
 896  * as well.
 897  */
 898 static int plat_mpc8xxx_spi_probe(struct platform_device *pdev)
 899 {
 900         struct resource *mem;
 901         int irq;
 902         struct spi_master *master;
 903
 904         if (!dev_get_platdata(&pdev->dev))
 905                 return -EINVAL;
 906
 907         mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 908         if (!mem)
 909                 return -EINVAL;
 910
 911         irq = platform_get_irq(pdev, 0);
 912         if (irq <= 0)
 913                 return -EINVAL;
 914
 915         master = fsl_spi_probe(&pdev->dev, mem, irq);
 916         return PTR_ERR_OR_ZERO(master);
 917 }
 918
 919 static int plat_mpc8xxx_spi_remove(struct platform_device *pdev)
 920 {
 921         return mpc8xxx_spi_remove(&pdev->dev);
 922 }
 923
 924 MODULE_ALIAS("platform:mpc8xxx_spi");
 925 static struct platform_driver mpc8xxx_spi_driver = {
 926         .probe = plat_mpc8xxx_spi_probe,
 927         .remove = plat_mpc8xxx_spi_remove,
 928         .driver = {
 929                 .name = "mpc8xxx_spi",
 930                 .owner = THIS_MODULE,
 931         },
 932 };
 933
 934 static bool legacy_driver_failed;
 935
 936 static void __init legacy_driver_register(void)
 937 {
 938         legacy_driver_failed = platform_driver_register(&mpc8xxx_spi_driver);
 939 }
 940
 941 static void __exit legacy_driver_unregister(void)
 942 {
 943         if (legacy_driver_failed)
 944                 return;
 945         platform_driver_unregister(&mpc8xxx_spi_driver);
 946 }
 947 #else
 948 static void __init legacy_driver_register(void) {}
 949 static void __exit legacy_driver_unregister(void) {}
 950 #endif /* CONFIG_MPC832x_RDB */
 951
 952 static int __init fsl_spi_init(void)
 953 {
 954         legacy_driver_register();
 955         return platform_driver_register(&of_fsl_spi_driver);
 956 }
 957 module_init(fsl_spi_init);
 958
 959 static void __exit fsl_spi_exit(void)
 960 {
 961         platform_driver_unregister(&of_fsl_spi_driver);
 962         legacy_driver_unregister();
 963 }
 964 module_exit(fsl_spi_exit);
 965
 966 MODULE_AUTHOR("Kumar Gala");
 967 MODULE_DESCRIPTION("Simple Freescale SPI Driver");
 968 MODULE_LICENSE("GPL");