drivers/tty/serial/ifx6x60.c

   1 /****************************************************************************
   2  *
   3  * Driver for the IFX 6x60 spi modem.
   4  *
   5  * Copyright (C) 2008 Option International
   6  * Copyright (C) 2008 Filip Aben <f.aben@option.com>
   7  *                    Denis Joseph Barrow <d.barow@option.com>
   8  *                    Jan Dumon <j.dumon@option.com>
   9  *
  10  * Copyright (C) 2009, 2010 Intel Corp
  11  * Russ Gorby <russ.gorby@intel.com>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License version 2 as
  15  * published by the Free Software Foundation.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  25  * USA
  26  *
  27  * Driver modified by Intel from Option gtm501l_spi.c
  28  *
  29  * Notes
  30  * o    The driver currently assumes a single device only. If you need to
  31  *      change this then look for saved_ifx_dev and add a device lookup
  32  * o    The driver is intended to be big-endian safe but has never been
  33  *      tested that way (no suitable hardware). There are a couple of FIXME
  34  *      notes by areas that may need addressing
  35  * o    Some of the GPIO naming/setup assumptions may need revisiting if
  36  *      you need to use this driver for another platform.
  37  *
  38  *****************************************************************************/
  39 #include <linux/dma-mapping.h>
  40 #include <linux/module.h>
  41 #include <linux/termios.h>
  42 #include <linux/tty.h>
  43 #include <linux/device.h>
  44 #include <linux/spi/spi.h>
  45 #include <linux/kfifo.h>
  46 #include <linux/tty_flip.h>
  47 #include <linux/timer.h>
  48 #include <linux/serial.h>
  49 #include <linux/interrupt.h>
  50 #include <linux/irq.h>
  51 #include <linux/rfkill.h>
  52 #include <linux/fs.h>
  53 #include <linux/ip.h>
  54 #include <linux/dmapool.h>
  55 #include <linux/gpio.h>
  56 #include <linux/sched.h>
  57 #include <linux/time.h>
  58 #include <linux/wait.h>
  59 #include <linux/pm.h>
  60 #include <linux/pm_runtime.h>
  61 #include <linux/spi/ifx_modem.h>
  62 #include <linux/delay.h>
  63 #include <linux/reboot.h>
  64
  65 #include "ifx6x60.h"
  66
  67 #define IFX_SPI_MORE_MASK               0x10
  68 #define IFX_SPI_MORE_BIT                4       /* bit position in u8 */
  69 #define IFX_SPI_CTS_BIT                 6       /* bit position in u8 */
  70 #define IFX_SPI_MODE                    SPI_MODE_1
  71 #define IFX_SPI_TTY_ID                  0
  72 #define IFX_SPI_TIMEOUT_SEC             2
  73 #define IFX_SPI_HEADER_0                (-1)
  74 #define IFX_SPI_HEADER_F                (-2)
  75
  76 #define PO_POST_DELAY           200
  77 #define IFX_MDM_RST_PMU 4
  78
  79 /* forward reference */
  80 static void ifx_spi_handle_srdy(struct ifx_spi_device *ifx_dev);
  81 static int ifx_modem_reboot_callback(struct notifier_block *nfb,
  82                                 unsigned long event, void *data);
  83 static int ifx_modem_power_off(struct ifx_spi_device *ifx_dev);
  84
  85 /* local variables */
  86 static int spi_bpw = 16;                /* 8, 16 or 32 bit word length */
  87 static struct tty_driver *tty_drv;
  88 static struct ifx_spi_device *saved_ifx_dev;
  89 static struct lock_class_key ifx_spi_key;
  90
  91 static struct notifier_block ifx_modem_reboot_notifier_block = {
  92         .notifier_call = ifx_modem_reboot_callback,
  93 };
  94
  95 static int ifx_modem_power_off(struct ifx_spi_device *ifx_dev)
  96 {
  97         gpio_set_value(IFX_MDM_RST_PMU, 1);
  98         msleep(PO_POST_DELAY);
  99
 100         return 0;
 101 }
 102
 103 static int ifx_modem_reboot_callback(struct notifier_block *nfb,
 104                                  unsigned long event, void *data)
 105 {
 106         if (saved_ifx_dev)
 107                 ifx_modem_power_off(saved_ifx_dev);
 108         else
 109                 pr_warn("no ifx modem active;\n");
 110
 111         return NOTIFY_OK;
 112 }
 113
 114 /* GPIO/GPE settings */
 115
 116 /**
 117  *      mrdy_set_high           -       set MRDY GPIO
 118  *      @ifx: device we are controlling
 119  *
 120  */
 121 static inline void mrdy_set_high(struct ifx_spi_device *ifx)
 122 {
 123         gpio_set_value(ifx->gpio.mrdy, 1);
 124 }
 125
 126 /**
 127  *      mrdy_set_low            -       clear MRDY GPIO
 128  *      @ifx: device we are controlling
 129  *
 130  */
 131 static inline void mrdy_set_low(struct ifx_spi_device *ifx)
 132 {
 133         gpio_set_value(ifx->gpio.mrdy, 0);
 134 }
 135
 136 /**
 137  *      ifx_spi_power_state_set
 138  *      @ifx_dev: our SPI device
 139  *      @val: bits to set
 140  *
 141  *      Set bit in power status and signal power system if status becomes non-0
 142  */
 143 static void
 144 ifx_spi_power_state_set(struct ifx_spi_device *ifx_dev, unsigned char val)
 145 {
 146         unsigned long flags;
 147
 148         spin_lock_irqsave(&ifx_dev->power_lock, flags);
 149
 150         /*
 151          * if power status is already non-0, just update, else
 152          * tell power system
 153          */
 154         if (!ifx_dev->power_status)
 155                 pm_runtime_get(&ifx_dev->spi_dev->dev);
 156         ifx_dev->power_status |= val;
 157
 158         spin_unlock_irqrestore(&ifx_dev->power_lock, flags);
 159 }
 160
 161 /**
 162  *      ifx_spi_power_state_clear       -       clear power bit
 163  *      @ifx_dev: our SPI device
 164  *      @val: bits to clear
 165  *
 166  *      clear bit in power status and signal power system if status becomes 0
 167  */
 168 static void
 169 ifx_spi_power_state_clear(struct ifx_spi_device *ifx_dev, unsigned char val)
 170 {
 171         unsigned long flags;
 172
 173         spin_lock_irqsave(&ifx_dev->power_lock, flags);
 174
 175         if (ifx_dev->power_status) {
 176                 ifx_dev->power_status &= ~val;
 177                 if (!ifx_dev->power_status)
 178                         pm_runtime_put(&ifx_dev->spi_dev->dev);
 179         }
 180
 181         spin_unlock_irqrestore(&ifx_dev->power_lock, flags);
 182 }
 183
 184 /**
 185  *      swap_buf_8
 186  *      @buf: our buffer
 187  *      @len : number of bytes (not words) in the buffer
 188  *      @end: end of buffer
 189  *
 190  *      Swap the contents of a buffer into big endian format
 191  */
 192 static inline void swap_buf_8(unsigned char *buf, int len, void *end)
 193 {
 194         /* don't swap buffer if SPI word width is 8 bits */
 195         return;
 196 }
 197
 198 /**
 199  *      swap_buf_16
 200  *      @buf: our buffer
 201  *      @len : number of bytes (not words) in the buffer
 202  *      @end: end of buffer
 203  *
 204  *      Swap the contents of a buffer into big endian format
 205  */
 206 static inline void swap_buf_16(unsigned char *buf, int len, void *end)
 207 {
 208         int n;
 209
 210         u16 *buf_16 = (u16 *)buf;
 211         len = ((len + 1) >> 1);
 212         if ((void *)&buf_16[len] > end) {
 213                 pr_err("swap_buf_16: swap exceeds boundary (%p > %p)!",
 214                        &buf_16[len], end);
 215                 return;
 216         }
 217         for (n = 0; n < len; n++) {
 218                 *buf_16 = cpu_to_be16(*buf_16);
 219                 buf_16++;
 220         }
 221 }
 222
 223 /**
 224  *      swap_buf_32
 225  *      @buf: our buffer
 226  *      @len : number of bytes (not words) in the buffer
 227  *      @end: end of buffer
 228  *
 229  *      Swap the contents of a buffer into big endian format
 230  */
 231 static inline void swap_buf_32(unsigned char *buf, int len, void *end)
 232 {
 233         int n;
 234
 235         u32 *buf_32 = (u32 *)buf;
 236         len = (len + 3) >> 2;
 237
 238         if ((void *)&buf_32[len] > end) {
 239                 pr_err("swap_buf_32: swap exceeds boundary (%p > %p)!\n",
 240                        &buf_32[len], end);
 241                 return;
 242         }
 243         for (n = 0; n < len; n++) {
 244                 *buf_32 = cpu_to_be32(*buf_32);
 245                 buf_32++;
 246         }
 247 }
 248
 249 /**
 250  *      mrdy_assert             -       assert MRDY line
 251  *      @ifx_dev: our SPI device
 252  *
 253  *      Assert mrdy and set timer to wait for SRDY interrupt, if SRDY is low
 254  *      now.
 255  *
 256  *      FIXME: Can SRDY even go high as we are running this code ?
 257  */
 258 static void mrdy_assert(struct ifx_spi_device *ifx_dev)
 259 {
 260         int val = gpio_get_value(ifx_dev->gpio.srdy);
 261         if (!val) {
 262                 if (!test_and_set_bit(IFX_SPI_STATE_TIMER_PENDING,
 263                                       &ifx_dev->flags)) {
 264                         mod_timer(&ifx_dev->spi_timer,jiffies + IFX_SPI_TIMEOUT_SEC*HZ);
 265
 266                 }
 267         }
 268         ifx_spi_power_state_set(ifx_dev, IFX_SPI_POWER_DATA_PENDING);
 269         mrdy_set_high(ifx_dev);
 270 }
 271
 272 /**
 273  *      ifx_spi_hangup          -       hang up an IFX device
 274  *      @ifx_dev: our SPI device
 275  *
 276  *      Hang up the tty attached to the IFX device if one is currently
 277  *      open. If not take no action
 278  */
 279 static void ifx_spi_ttyhangup(struct ifx_spi_device *ifx_dev)
 280 {
 281         struct tty_port *pport = &ifx_dev->tty_port;
 282         struct tty_struct *tty = tty_port_tty_get(pport);
 283         if (tty) {
 284                 tty_hangup(tty);
 285                 tty_kref_put(tty);
 286         }
 287 }
 288
 289 /**
 290  *      ifx_spi_timeout         -       SPI timeout
 291  *      @arg: our SPI device
 292  *
 293  *      The SPI has timed out: hang up the tty. Users will then see a hangup
 294  *      and error events.
 295  */
 296 static void ifx_spi_timeout(unsigned long arg)
 297 {
 298         struct ifx_spi_device *ifx_dev = (struct ifx_spi_device *)arg;
 299
 300         dev_warn(&ifx_dev->spi_dev->dev, "*** SPI Timeout ***");
 301         ifx_spi_ttyhangup(ifx_dev);
 302         mrdy_set_low(ifx_dev);
 303         clear_bit(IFX_SPI_STATE_TIMER_PENDING, &ifx_dev->flags);
 304 }
 305
 306 /* char/tty operations */
 307
 308 /**
 309  *      ifx_spi_tiocmget        -       get modem lines
 310  *      @tty: our tty device
 311  *      @filp: file handle issuing the request
 312  *
 313  *      Map the signal state into Linux modem flags and report the value
 314  *      in Linux terms
 315  */
 316 static int ifx_spi_tiocmget(struct tty_struct *tty)
 317 {
 318         unsigned int value;
 319         struct ifx_spi_device *ifx_dev = tty->driver_data;
 320
 321         value =
 322         (test_bit(IFX_SPI_RTS, &ifx_dev->signal_state) ? TIOCM_RTS : 0) |
 323         (test_bit(IFX_SPI_DTR, &ifx_dev->signal_state) ? TIOCM_DTR : 0) |
 324         (test_bit(IFX_SPI_CTS, &ifx_dev->signal_state) ? TIOCM_CTS : 0) |
 325         (test_bit(IFX_SPI_DSR, &ifx_dev->signal_state) ? TIOCM_DSR : 0) |
 326         (test_bit(IFX_SPI_DCD, &ifx_dev->signal_state) ? TIOCM_CAR : 0) |
 327         (test_bit(IFX_SPI_RI, &ifx_dev->signal_state) ? TIOCM_RNG : 0);
 328         return value;
 329 }
 330
 331 /**
 332  *      ifx_spi_tiocmset        -       set modem bits
 333  *      @tty: the tty structure
 334  *      @set: bits to set
 335  *      @clear: bits to clear
 336  *
 337  *      The IFX6x60 only supports DTR and RTS. Set them accordingly
 338  *      and flag that an update to the modem is needed.
 339  *
 340  *      FIXME: do we need to kick the tranfers when we do this ?
 341  */
 342 static int ifx_spi_tiocmset(struct tty_struct *tty,
 343                             unsigned int set, unsigned int clear)
 344 {
 345         struct ifx_spi_device *ifx_dev = tty->driver_data;
 346
 347         if (set & TIOCM_RTS)
 348                 set_bit(IFX_SPI_RTS, &ifx_dev->signal_state);
 349         if (set & TIOCM_DTR)
 350                 set_bit(IFX_SPI_DTR, &ifx_dev->signal_state);
 351         if (clear & TIOCM_RTS)
 352                 clear_bit(IFX_SPI_RTS, &ifx_dev->signal_state);
 353         if (clear & TIOCM_DTR)
 354                 clear_bit(IFX_SPI_DTR, &ifx_dev->signal_state);
 355
 356         set_bit(IFX_SPI_UPDATE, &ifx_dev->signal_state);
 357         return 0;
 358 }
 359
 360 /**
 361  *      ifx_spi_open    -       called on tty open
 362  *      @tty: our tty device
 363  *      @filp: file handle being associated with the tty
 364  *
 365  *      Open the tty interface. We let the tty_port layer do all the work
 366  *      for us.
 367  *
 368  *      FIXME: Remove single device assumption and saved_ifx_dev
 369  */
 370 static int ifx_spi_open(struct tty_struct *tty, struct file *filp)
 371 {
 372         return tty_port_open(&saved_ifx_dev->tty_port, tty, filp);
 373 }
 374
 375 /**
 376  *      ifx_spi_close   -       called when our tty closes
 377  *      @tty: the tty being closed
 378  *      @filp: the file handle being closed
 379  *
 380  *      Perform the close of the tty. We use the tty_port layer to do all
 381  *      our hard work.
 382  */
 383 static void ifx_spi_close(struct tty_struct *tty, struct file *filp)
 384 {
 385         struct ifx_spi_device *ifx_dev = tty->driver_data;
 386         tty_port_close(&ifx_dev->tty_port, tty, filp);
 387         /* FIXME: should we do an ifx_spi_reset here ? */
 388 }
 389
 390 /**
 391  *      ifx_decode_spi_header   -       decode received header
 392  *      @buffer: the received data
 393  *      @length: decoded length
 394  *      @more: decoded more flag
 395  *      @received_cts: status of cts we received
 396  *
 397  *      Note how received_cts is handled -- if header is all F it is left
 398  *      the same as it was, if header is all 0 it is set to 0 otherwise it is
 399  *      taken from the incoming header.
 400  *
 401  *      FIXME: endianness
 402  */
 403 static int ifx_spi_decode_spi_header(unsigned char *buffer, int *length,
 404                         unsigned char *more, unsigned char *received_cts)
 405 {
 406         u16 h1;
 407         u16 h2;
 408         u16 *in_buffer = (u16 *)buffer;
 409
 410         h1 = *in_buffer;
 411         h2 = *(in_buffer+1);
 412
 413         if (h1 == 0 && h2 == 0) {
 414                 *received_cts = 0;
 415                 return IFX_SPI_HEADER_0;
 416         } else if (h1 == 0xffff && h2 == 0xffff) {
 417                 /* spi_slave_cts remains as it was */
 418                 return IFX_SPI_HEADER_F;
 419         }
 420
 421         *length = h1 & 0xfff;   /* upper bits of byte are flags */
 422         *more = (buffer[1] >> IFX_SPI_MORE_BIT) & 1;
 423         *received_cts = (buffer[3] >> IFX_SPI_CTS_BIT) & 1;
 424         return 0;
 425 }
 426
 427 /**
 428  *      ifx_setup_spi_header    -       set header fields
 429  *      @txbuffer: pointer to start of SPI buffer
 430  *      @tx_count: bytes
 431  *      @more: indicate if more to follow
 432  *
 433  *      Format up an SPI header for a transfer
 434  *
 435  *      FIXME: endianness?
 436  */
 437 static void ifx_spi_setup_spi_header(unsigned char *txbuffer, int tx_count,
 438                                         unsigned char more)
 439 {
 440         *(u16 *)(txbuffer) = tx_count;
 441         *(u16 *)(txbuffer+2) = IFX_SPI_PAYLOAD_SIZE;
 442         txbuffer[1] |= (more << IFX_SPI_MORE_BIT) & IFX_SPI_MORE_MASK;
 443 }
 444
 445 /**
 446  *      ifx_spi_wakeup_serial   -       SPI space made
 447  *      @port_data: our SPI device
 448  *
 449  *      We have emptied the FIFO enough that we want to get more data
 450  *      queued into it. Poke the line discipline via tty_wakeup so that
 451  *      it will feed us more bits
 452  */
 453 static void ifx_spi_wakeup_serial(struct ifx_spi_device *ifx_dev)
 454 {
 455         struct tty_struct *tty;
 456
 457         tty = tty_port_tty_get(&ifx_dev->tty_port);
 458         if (!tty)
 459                 return;
 460         tty_wakeup(tty);
 461         tty_kref_put(tty);
 462 }
 463
 464 /**
 465  *      ifx_spi_prepare_tx_buffer       -       prepare transmit frame
 466  *      @ifx_dev: our SPI device
 467  *
 468  *      The transmit buffr needs a header and various other bits of
 469  *      information followed by as much data as we can pull from the FIFO
 470  *      and transfer. This function formats up a suitable buffer in the
 471  *      ifx_dev->tx_buffer
 472  *
 473  *      FIXME: performance - should we wake the tty when the queue is half
 474  *                           empty ?
 475  */
 476 static int ifx_spi_prepare_tx_buffer(struct ifx_spi_device *ifx_dev)
 477 {
 478         int temp_count;
 479         int queue_length;
 480         int tx_count;
 481         unsigned char *tx_buffer;
 482
 483         tx_buffer = ifx_dev->tx_buffer;
 484         memset(tx_buffer, 0, IFX_SPI_TRANSFER_SIZE);
 485
 486         /* make room for required SPI header */
 487         tx_buffer += IFX_SPI_HEADER_OVERHEAD;
 488         tx_count = IFX_SPI_HEADER_OVERHEAD;
 489
 490         /* clear to signal no more data if this turns out to be the
 491          * last buffer sent in a sequence */
 492         ifx_dev->spi_more = 0;
 493
 494         /* if modem cts is set, just send empty buffer */
 495         if (!ifx_dev->spi_slave_cts) {
 496                 /* see if there's tx data */
 497                 queue_length = kfifo_len(&ifx_dev->tx_fifo);
 498                 if (queue_length != 0) {
 499                         /* data to mux -- see if there's room for it */
 500                         temp_count = min(queue_length, IFX_SPI_PAYLOAD_SIZE);
 501                         temp_count = kfifo_out_locked(&ifx_dev->tx_fifo,
 502                                         tx_buffer, temp_count,
 503                                         &ifx_dev->fifo_lock);
 504
 505                         /* update buffer pointer and data count in message */
 506                         tx_buffer += temp_count;
 507                         tx_count += temp_count;
 508                         if (temp_count == queue_length)
 509                                 /* poke port to get more data */
 510                                 ifx_spi_wakeup_serial(ifx_dev);
 511                         else /* more data in port, use next SPI message */
 512                                 ifx_dev->spi_more = 1;
 513                 }
 514         }
 515         /* have data and info for header -- set up SPI header in buffer */
 516         /* spi header needs payload size, not entire buffer size */
 517         ifx_spi_setup_spi_header(ifx_dev->tx_buffer,
 518                                         tx_count-IFX_SPI_HEADER_OVERHEAD,
 519                                         ifx_dev->spi_more);
 520         /* swap actual data in the buffer */
 521         ifx_dev->swap_buf((ifx_dev->tx_buffer), tx_count,
 522                 &ifx_dev->tx_buffer[IFX_SPI_TRANSFER_SIZE]);
 523         return tx_count;
 524 }
 525
 526 /**
 527  *      ifx_spi_write           -       line discipline write
 528  *      @tty: our tty device
 529  *      @buf: pointer to buffer to write (kernel space)
 530  *      @count: size of buffer
 531  *
 532  *      Write the characters we have been given into the FIFO. If the device
 533  *      is not active then activate it, when the SRDY line is asserted back
 534  *      this will commence I/O
 535  */
 536 static int ifx_spi_write(struct tty_struct *tty, const unsigned char *buf,
 537                          int count)
 538 {
 539         struct ifx_spi_device *ifx_dev = tty->driver_data;
 540         unsigned char *tmp_buf = (unsigned char *)buf;
 541         unsigned long flags;
 542         bool is_fifo_empty;
 543         int tx_count;
 544
 545         spin_lock_irqsave(&ifx_dev->fifo_lock, flags);
 546         is_fifo_empty = kfifo_is_empty(&ifx_dev->tx_fifo);
 547         tx_count = kfifo_in(&ifx_dev->tx_fifo, tmp_buf, count);
 548         spin_unlock_irqrestore(&ifx_dev->fifo_lock, flags);
 549         if (is_fifo_empty)
 550                 mrdy_assert(ifx_dev);
 551
 552         return tx_count;
 553 }
 554
 555 /**
 556  *      ifx_spi_chars_in_buffer -       line discipline helper
 557  *      @tty: our tty device
 558  *
 559  *      Report how much data we can accept before we drop bytes. As we use
 560  *      a simple FIFO this is nice and easy.
 561  */
 562 static int ifx_spi_write_room(struct tty_struct *tty)
 563 {
 564         struct ifx_spi_device *ifx_dev = tty->driver_data;
 565         return IFX_SPI_FIFO_SIZE - kfifo_len(&ifx_dev->tx_fifo);
 566 }
 567
 568 /**
 569  *      ifx_spi_chars_in_buffer -       line discipline helper
 570  *      @tty: our tty device
 571  *
 572  *      Report how many characters we have buffered. In our case this is the
 573  *      number of bytes sitting in our transmit FIFO.
 574  */
 575 static int ifx_spi_chars_in_buffer(struct tty_struct *tty)
 576 {
 577         struct ifx_spi_device *ifx_dev = tty->driver_data;
 578         return kfifo_len(&ifx_dev->tx_fifo);
 579 }
 580
 581 /**
 582  *      ifx_port_hangup
 583  *      @port: our tty port
 584  *
 585  *      tty port hang up. Called when tty_hangup processing is invoked either
 586  *      by loss of carrier, or by software (eg vhangup). Serialized against
 587  *      activate/shutdown by the tty layer.
 588  */
 589 static void ifx_spi_hangup(struct tty_struct *tty)
 590 {
 591         struct ifx_spi_device *ifx_dev = tty->driver_data;
 592         tty_port_hangup(&ifx_dev->tty_port);
 593 }
 594
 595 /**
 596  *      ifx_port_activate
 597  *      @port: our tty port
 598  *
 599  *      tty port activate method - called for first open. Serialized
 600  *      with hangup and shutdown by the tty layer.
 601  */
 602 static int ifx_port_activate(struct tty_port *port, struct tty_struct *tty)
 603 {
 604         struct ifx_spi_device *ifx_dev =
 605                 container_of(port, struct ifx_spi_device, tty_port);
 606
 607         /* clear any old data; can't do this in 'close' */
 608         kfifo_reset(&ifx_dev->tx_fifo);
 609
 610         /* clear any flag which may be set in port shutdown procedure */
 611         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags);
 612         clear_bit(IFX_SPI_STATE_IO_READY, &ifx_dev->flags);
 613
 614         /* put port data into this tty */
 615         tty->driver_data = ifx_dev;
 616
 617         /* allows flip string push from int context */
 618         tty->low_latency = 1;
 619
 620         /* set flag to allows data transfer */
 621         set_bit(IFX_SPI_STATE_IO_AVAILABLE, &ifx_dev->flags);
 622
 623         return 0;
 624 }
 625
 626 /**
 627  *      ifx_port_shutdown
 628  *      @port: our tty port
 629  *
 630  *      tty port shutdown method - called for last port close. Serialized
 631  *      with hangup and activate by the tty layer.
 632  */
 633 static void ifx_port_shutdown(struct tty_port *port)
 634 {
 635         struct ifx_spi_device *ifx_dev =
 636                 container_of(port, struct ifx_spi_device, tty_port);
 637
 638         clear_bit(IFX_SPI_STATE_IO_AVAILABLE, &ifx_dev->flags);
 639         mrdy_set_low(ifx_dev);
 640         clear_bit(IFX_SPI_STATE_TIMER_PENDING, &ifx_dev->flags);
 641         tasklet_kill(&ifx_dev->io_work_tasklet);
 642 }
 643
 644 static const struct tty_port_operations ifx_tty_port_ops = {
 645         .activate = ifx_port_activate,
 646         .shutdown = ifx_port_shutdown,
 647 };
 648
 649 static const struct tty_operations ifx_spi_serial_ops = {
 650         .open = ifx_spi_open,
 651         .close = ifx_spi_close,
 652         .write = ifx_spi_write,
 653         .hangup = ifx_spi_hangup,
 654         .write_room = ifx_spi_write_room,
 655         .chars_in_buffer = ifx_spi_chars_in_buffer,
 656         .tiocmget = ifx_spi_tiocmget,
 657         .tiocmset = ifx_spi_tiocmset,
 658 };
 659
 660 /**
 661  *      ifx_spi_insert_fip_string       -       queue received data
 662  *      @ifx_ser: our SPI device
 663  *      @chars: buffer we have received
 664  *      @size: number of chars reeived
 665  *
 666  *      Queue bytes to the tty assuming the tty side is currently open. If
 667  *      not the discard the data.
 668  */
 669 static void ifx_spi_insert_flip_string(struct ifx_spi_device *ifx_dev,
 670                                     unsigned char *chars, size_t size)
 671 {
 672         struct tty_struct *tty = tty_port_tty_get(&ifx_dev->tty_port);
 673         if (!tty)
 674                 return;
 675         tty_insert_flip_string(tty, chars, size);
 676         tty_flip_buffer_push(tty);
 677         tty_kref_put(tty);
 678 }
 679
 680 /**
 681  *      ifx_spi_complete        -       SPI transfer completed
 682  *      @ctx: our SPI device
 683  *
 684  *      An SPI transfer has completed. Process any received data and kick off
 685  *      any further transmits we can commence.
 686  */
 687 static void ifx_spi_complete(void *ctx)
 688 {
 689         struct ifx_spi_device *ifx_dev = ctx;
 690         struct tty_struct *tty;
 691         struct tty_ldisc *ldisc = NULL;
 692         int length;
 693         int actual_length;
 694         unsigned char more;
 695         unsigned char cts;
 696         int local_write_pending = 0;
 697         int queue_length;
 698         int srdy;
 699         int decode_result;
 700
 701         mrdy_set_low(ifx_dev);
 702
 703         if (!ifx_dev->spi_msg.status) {
 704                 /* check header validity, get comm flags */
 705                 ifx_dev->swap_buf(ifx_dev->rx_buffer, IFX_SPI_HEADER_OVERHEAD,
 706                         &ifx_dev->rx_buffer[IFX_SPI_HEADER_OVERHEAD]);
 707                 decode_result = ifx_spi_decode_spi_header(ifx_dev->rx_buffer,
 708                                 &length, &more, &cts);
 709                 if (decode_result == IFX_SPI_HEADER_0) {
 710                         dev_dbg(&ifx_dev->spi_dev->dev,
 711                                 "ignore input: invalid header 0");
 712                         ifx_dev->spi_slave_cts = 0;
 713                         goto complete_exit;
 714                 } else if (decode_result == IFX_SPI_HEADER_F) {
 715                         dev_dbg(&ifx_dev->spi_dev->dev,
 716                                 "ignore input: invalid header F");
 717                         goto complete_exit;
 718                 }
 719
 720                 ifx_dev->spi_slave_cts = cts;
 721
 722                 actual_length = min((unsigned int)length,
 723                                         ifx_dev->spi_msg.actual_length);
 724                 ifx_dev->swap_buf(
 725                         (ifx_dev->rx_buffer + IFX_SPI_HEADER_OVERHEAD),
 726                          actual_length,
 727                          &ifx_dev->rx_buffer[IFX_SPI_TRANSFER_SIZE]);
 728                 ifx_spi_insert_flip_string(
 729                         ifx_dev,
 730                         ifx_dev->rx_buffer + IFX_SPI_HEADER_OVERHEAD,
 731                         (size_t)actual_length);
 732         } else {
 733                 dev_dbg(&ifx_dev->spi_dev->dev, "SPI transfer error %d",
 734                        ifx_dev->spi_msg.status);
 735         }
 736
 737 complete_exit:
 738         if (ifx_dev->write_pending) {
 739                 ifx_dev->write_pending = 0;
 740                 local_write_pending = 1;
 741         }
 742
 743         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &(ifx_dev->flags));
 744
 745         queue_length = kfifo_len(&ifx_dev->tx_fifo);
 746         srdy = gpio_get_value(ifx_dev->gpio.srdy);
 747         if (!srdy)
 748                 ifx_spi_power_state_clear(ifx_dev, IFX_SPI_POWER_SRDY);
 749
 750         /* schedule output if there is more to do */
 751         if (test_and_clear_bit(IFX_SPI_STATE_IO_READY, &ifx_dev->flags))
 752                 tasklet_schedule(&ifx_dev->io_work_tasklet);
 753         else {
 754                 if (more || ifx_dev->spi_more || queue_length > 0 ||
 755                         local_write_pending) {
 756                         if (ifx_dev->spi_slave_cts) {
 757                                 if (more)
 758                                         mrdy_assert(ifx_dev);
 759                         } else
 760                                 mrdy_assert(ifx_dev);
 761                 } else {
 762                         /*
 763                          * poke line discipline driver if any for more data
 764                          * may or may not get more data to write
 765                          * for now, say not busy
 766                          */
 767                         ifx_spi_power_state_clear(ifx_dev,
 768                                                   IFX_SPI_POWER_DATA_PENDING);
 769                         tty = tty_port_tty_get(&ifx_dev->tty_port);
 770                         if (tty) {
 771                                 ldisc = tty_ldisc_ref(tty);
 772                                 if (ldisc) {
 773                                         ldisc->ops->write_wakeup(tty);
 774                                         tty_ldisc_deref(ldisc);
 775                                 }
 776                                 tty_kref_put(tty);
 777                         }
 778                 }
 779         }
 780 }
 781
 782 /**
 783  *      ifx_spio_io             -       I/O tasklet
 784  *      @data: our SPI device
 785  *
 786  *      Queue data for transmission if possible and then kick off the
 787  *      transfer.
 788  */
 789 static void ifx_spi_io(unsigned long data)
 790 {
 791         int retval;
 792         struct ifx_spi_device *ifx_dev = (struct ifx_spi_device *) data;
 793
 794         if (!test_and_set_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags) &&
 795                 test_bit(IFX_SPI_STATE_IO_AVAILABLE, &ifx_dev->flags)) {
 796                 if (ifx_dev->gpio.unack_srdy_int_nb > 0)
 797                         ifx_dev->gpio.unack_srdy_int_nb--;
 798
 799                 ifx_spi_prepare_tx_buffer(ifx_dev);
 800
 801                 spi_message_init(&ifx_dev->spi_msg);
 802                 INIT_LIST_HEAD(&ifx_dev->spi_msg.queue);
 803
 804                 ifx_dev->spi_msg.context = ifx_dev;
 805                 ifx_dev->spi_msg.complete = ifx_spi_complete;
 806
 807                 /* set up our spi transfer */
 808                 /* note len is BYTES, not transfers */
 809                 ifx_dev->spi_xfer.len = IFX_SPI_TRANSFER_SIZE;
 810                 ifx_dev->spi_xfer.cs_change = 0;
 811                 ifx_dev->spi_xfer.speed_hz = ifx_dev->spi_dev->max_speed_hz;
 812                 /* ifx_dev->spi_xfer.speed_hz = 390625; */
 813                 ifx_dev->spi_xfer.bits_per_word = spi_bpw;
 814
 815                 ifx_dev->spi_xfer.tx_buf = ifx_dev->tx_buffer;
 816                 ifx_dev->spi_xfer.rx_buf = ifx_dev->rx_buffer;
 817
 818                 /*
 819                  * setup dma pointers
 820                  */
 821                 if (ifx_dev->use_dma) {
 822                         ifx_dev->spi_msg.is_dma_mapped = 1;
 823                         ifx_dev->tx_dma = ifx_dev->tx_bus;
 824                         ifx_dev->rx_dma = ifx_dev->rx_bus;
 825                         ifx_dev->spi_xfer.tx_dma = ifx_dev->tx_dma;
 826                         ifx_dev->spi_xfer.rx_dma = ifx_dev->rx_dma;
 827                 } else {
 828                         ifx_dev->spi_msg.is_dma_mapped = 0;
 829                         ifx_dev->tx_dma = (dma_addr_t)0;
 830                         ifx_dev->rx_dma = (dma_addr_t)0;
 831                         ifx_dev->spi_xfer.tx_dma = (dma_addr_t)0;
 832                         ifx_dev->spi_xfer.rx_dma = (dma_addr_t)0;
 833                 }
 834
 835                 spi_message_add_tail(&ifx_dev->spi_xfer, &ifx_dev->spi_msg);
 836
 837                 /* Assert MRDY. This may have already been done by the write
 838                  * routine.
 839                  */
 840                 mrdy_assert(ifx_dev);
 841
 842                 retval = spi_async(ifx_dev->spi_dev, &ifx_dev->spi_msg);
 843                 if (retval) {
 844                         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS,
 845                                   &ifx_dev->flags);
 846                         tasklet_schedule(&ifx_dev->io_work_tasklet);
 847                         return;
 848                 }
 849         } else
 850                 ifx_dev->write_pending = 1;
 851 }
 852
 853 /**
 854  *      ifx_spi_free_port       -       free up the tty side
 855  *      @ifx_dev: IFX device going away
 856  *
 857  *      Unregister and free up a port when the device goes away
 858  */
 859 static void ifx_spi_free_port(struct ifx_spi_device *ifx_dev)
 860 {
 861         if (ifx_dev->tty_dev)
 862                 tty_unregister_device(tty_drv, ifx_dev->minor);
 863         tty_port_destroy(&ifx_dev->tty_port);
 864         kfifo_free(&ifx_dev->tx_fifo);
 865 }
 866
 867 /**
 868  *      ifx_spi_create_port     -       create a new port
 869  *      @ifx_dev: our spi device
 870  *
 871  *      Allocate and initialise the tty port that goes with this interface
 872  *      and add it to the tty layer so that it can be opened.
 873  */
 874 static int ifx_spi_create_port(struct ifx_spi_device *ifx_dev)
 875 {
 876         int ret = 0;
 877         struct tty_port *pport = &ifx_dev->tty_port;
 878
 879         spin_lock_init(&ifx_dev->fifo_lock);
 880         lockdep_set_class_and_subclass(&ifx_dev->fifo_lock,
 881                 &ifx_spi_key, 0);
 882
 883         if (kfifo_alloc(&ifx_dev->tx_fifo, IFX_SPI_FIFO_SIZE, GFP_KERNEL)) {
 884                 ret = -ENOMEM;
 885                 goto error_ret;
 886         }
 887
 888         tty_port_init(pport);
 889         pport->ops = &ifx_tty_port_ops;
 890         ifx_dev->minor = IFX_SPI_TTY_ID;
 891         ifx_dev->tty_dev = tty_port_register_device(pport, tty_drv,
 892                         ifx_dev->minor, &ifx_dev->spi_dev->dev);
 893         if (IS_ERR(ifx_dev->tty_dev)) {
 894                 dev_dbg(&ifx_dev->spi_dev->dev,
 895                         "%s: registering tty device failed", __func__);
 896                 ret = PTR_ERR(ifx_dev->tty_dev);
 897                 goto error_port;
 898         }
 899         return 0;
 900
 901 error_port:
 902         tty_port_destroy(pport);
 903 error_ret:
 904         ifx_spi_free_port(ifx_dev);
 905         return ret;
 906 }
 907
 908 /**
 909  *      ifx_spi_handle_srdy             -       handle SRDY
 910  *      @ifx_dev: device asserting SRDY
 911  *
 912  *      Check our device state and see what we need to kick off when SRDY
 913  *      is asserted. This usually means killing the timer and firing off the
 914  *      I/O processing.
 915  */
 916 static void ifx_spi_handle_srdy(struct ifx_spi_device *ifx_dev)
 917 {
 918         if (test_bit(IFX_SPI_STATE_TIMER_PENDING, &ifx_dev->flags)) {
 919                 del_timer(&ifx_dev->spi_timer);
 920                 clear_bit(IFX_SPI_STATE_TIMER_PENDING, &ifx_dev->flags);
 921         }
 922
 923         ifx_spi_power_state_set(ifx_dev, IFX_SPI_POWER_SRDY);
 924
 925         if (!test_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags))
 926                 tasklet_schedule(&ifx_dev->io_work_tasklet);
 927         else
 928                 set_bit(IFX_SPI_STATE_IO_READY, &ifx_dev->flags);
 929 }
 930
 931 /**
 932  *      ifx_spi_srdy_interrupt  -       SRDY asserted
 933  *      @irq: our IRQ number
 934  *      @dev: our ifx device
 935  *
 936  *      The modem asserted SRDY. Handle the srdy event
 937  */
 938 static irqreturn_t ifx_spi_srdy_interrupt(int irq, void *dev)
 939 {
 940         struct ifx_spi_device *ifx_dev = dev;
 941         ifx_dev->gpio.unack_srdy_int_nb++;
 942         ifx_spi_handle_srdy(ifx_dev);
 943         return IRQ_HANDLED;
 944 }
 945
 946 /**
 947  *      ifx_spi_reset_interrupt -       Modem has changed reset state
 948  *      @irq: interrupt number
 949  *      @dev: our device pointer
 950  *
 951  *      The modem has either entered or left reset state. Check the GPIO
 952  *      line to see which.
 953  *
 954  *      FIXME: review locking on MR_INPROGRESS versus
 955  *      parallel unsolicited reset/solicited reset
 956  */
 957 static irqreturn_t ifx_spi_reset_interrupt(int irq, void *dev)
 958 {
 959         struct ifx_spi_device *ifx_dev = dev;
 960         int val = gpio_get_value(ifx_dev->gpio.reset_out);
 961         int solreset = test_bit(MR_START, &ifx_dev->mdm_reset_state);
 962
 963         if (val == 0) {
 964                 /* entered reset */
 965                 set_bit(MR_INPROGRESS, &ifx_dev->mdm_reset_state);
 966                 if (!solreset) {
 967                         /* unsolicited reset  */
 968                         ifx_spi_ttyhangup(ifx_dev);
 969                 }
 970         } else {
 971                 /* exited reset */
 972                 clear_bit(MR_INPROGRESS, &ifx_dev->mdm_reset_state);
 973                 if (solreset) {
 974                         set_bit(MR_COMPLETE, &ifx_dev->mdm_reset_state);
 975                         wake_up(&ifx_dev->mdm_reset_wait);
 976                 }
 977         }
 978         return IRQ_HANDLED;
 979 }
 980
 981 /**
 982  *      ifx_spi_free_device - free device
 983  *      @ifx_dev: device to free
 984  *
 985  *      Free the IFX device
 986  */
 987 static void ifx_spi_free_device(struct ifx_spi_device *ifx_dev)
 988 {
 989         ifx_spi_free_port(ifx_dev);
 990         dma_free_coherent(&ifx_dev->spi_dev->dev,
 991                                 IFX_SPI_TRANSFER_SIZE,
 992                                 ifx_dev->tx_buffer,
 993                                 ifx_dev->tx_bus);
 994         dma_free_coherent(&ifx_dev->spi_dev->dev,
 995                                 IFX_SPI_TRANSFER_SIZE,
 996                                 ifx_dev->rx_buffer,
 997                                 ifx_dev->rx_bus);
 998 }
 999
1000 /**
1001  *      ifx_spi_reset   -       reset modem
1002  *      @ifx_dev: modem to reset
1003  *
1004  *      Perform a reset on the modem
1005  */
1006 static int ifx_spi_reset(struct ifx_spi_device *ifx_dev)
1007 {
1008         int ret;
1009         /*
1010          * set up modem power, reset
1011          *
1012          * delays are required on some platforms for the modem
1013          * to reset properly
1014          */
1015         set_bit(MR_START, &ifx_dev->mdm_reset_state);
1016         gpio_set_value(ifx_dev->gpio.po, 0);
1017         gpio_set_value(ifx_dev->gpio.reset, 0);
1018         msleep(25);
1019         gpio_set_value(ifx_dev->gpio.reset, 1);
1020         msleep(1);
1021         gpio_set_value(ifx_dev->gpio.po, 1);
1022         msleep(1);
1023         gpio_set_value(ifx_dev->gpio.po, 0);
1024         ret = wait_event_timeout(ifx_dev->mdm_reset_wait,
1025                                  test_bit(MR_COMPLETE,
1026                                           &ifx_dev->mdm_reset_state),
1027                                  IFX_RESET_TIMEOUT);
1028         if (!ret)
1029                 dev_warn(&ifx_dev->spi_dev->dev, "Modem reset timeout: (state:%lx)",
1030                          ifx_dev->mdm_reset_state);
1031
1032         ifx_dev->mdm_reset_state = 0;
1033         return ret;
1034 }
1035
1036 /**
1037  *      ifx_spi_spi_probe       -       probe callback
1038  *      @spi: our possible matching SPI device
1039  *
1040  *      Probe for a 6x60 modem on SPI bus. Perform any needed device and
1041  *      GPIO setup.
1042  *
1043  *      FIXME:
1044  *      -       Support for multiple devices
1045  *      -       Split out MID specific GPIO handling eventually
1046  */
1047
1048 static int ifx_spi_spi_probe(struct spi_device *spi)
1049 {
1050         int ret;
1051         int srdy;
1052         struct ifx_modem_platform_data *pl_data;
1053         struct ifx_spi_device *ifx_dev;
1054
1055         if (saved_ifx_dev) {
1056                 dev_dbg(&spi->dev, "ignoring subsequent detection");
1057                 return -ENODEV;
1058         }
1059
1060         pl_data = (struct ifx_modem_platform_data *)spi->dev.platform_data;
1061         if (!pl_data) {
1062                 dev_err(&spi->dev, "missing platform data!");
1063                 return -ENODEV;
1064         }
1065
1066         /* initialize structure to hold our device variables */
1067         ifx_dev = kzalloc(sizeof(struct ifx_spi_device), GFP_KERNEL);
1068         if (!ifx_dev) {
1069                 dev_err(&spi->dev, "spi device allocation failed");
1070                 return -ENOMEM;
1071         }
1072         saved_ifx_dev = ifx_dev;
1073         ifx_dev->spi_dev = spi;
1074         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags);
1075         spin_lock_init(&ifx_dev->write_lock);
1076         spin_lock_init(&ifx_dev->power_lock);
1077         ifx_dev->power_status = 0;
1078         init_timer(&ifx_dev->spi_timer);
1079         ifx_dev->spi_timer.function = ifx_spi_timeout;
1080         ifx_dev->spi_timer.data = (unsigned long)ifx_dev;
1081         ifx_dev->modem = pl_data->modem_type;
1082         ifx_dev->use_dma = pl_data->use_dma;
1083         ifx_dev->max_hz = pl_data->max_hz;
1084         /* initialize spi mode, etc */
1085         spi->max_speed_hz = ifx_dev->max_hz;
1086         spi->mode = IFX_SPI_MODE | (SPI_LOOP & spi->mode);
1087         spi->bits_per_word = spi_bpw;
1088         ret = spi_setup(spi);
1089         if (ret) {
1090                 dev_err(&spi->dev, "SPI setup wasn't successful %d", ret);
1091                 return -ENODEV;
1092         }
1093
1094         /* init swap_buf function according to word width configuration */
1095         if (spi->bits_per_word == 32)
1096                 ifx_dev->swap_buf = swap_buf_32;
1097         else if (spi->bits_per_word == 16)
1098                 ifx_dev->swap_buf = swap_buf_16;
1099         else
1100                 ifx_dev->swap_buf = swap_buf_8;
1101
1102         /* ensure SPI protocol flags are initialized to enable transfer */
1103         ifx_dev->spi_more = 0;
1104         ifx_dev->spi_slave_cts = 0;
1105
1106         /*initialize transfer and dma buffers */
1107         ifx_dev->tx_buffer = dma_alloc_coherent(ifx_dev->spi_dev->dev.parent,
1108                                 IFX_SPI_TRANSFER_SIZE,
1109                                 &ifx_dev->tx_bus,
1110                                 GFP_KERNEL);
1111         if (!ifx_dev->tx_buffer) {
1112                 dev_err(&spi->dev, "DMA-TX buffer allocation failed");
1113                 ret = -ENOMEM;
1114                 goto error_ret;
1115         }
1116         ifx_dev->rx_buffer = dma_alloc_coherent(ifx_dev->spi_dev->dev.parent,
1117                                 IFX_SPI_TRANSFER_SIZE,
1118                                 &ifx_dev->rx_bus,
1119                                 GFP_KERNEL);
1120         if (!ifx_dev->rx_buffer) {
1121                 dev_err(&spi->dev, "DMA-RX buffer allocation failed");
1122                 ret = -ENOMEM;
1123                 goto error_ret;
1124         }
1125
1126         /* initialize waitq for modem reset */
1127         init_waitqueue_head(&ifx_dev->mdm_reset_wait);
1128
1129         spi_set_drvdata(spi, ifx_dev);
1130         tasklet_init(&ifx_dev->io_work_tasklet, ifx_spi_io,
1131                                                 (unsigned long)ifx_dev);
1132
1133         set_bit(IFX_SPI_STATE_PRESENT, &ifx_dev->flags);
1134
1135         /* create our tty port */
1136         ret = ifx_spi_create_port(ifx_dev);
1137         if (ret != 0) {
1138                 dev_err(&spi->dev, "create default tty port failed");
1139                 goto error_ret;
1140         }
1141
1142         ifx_dev->gpio.reset = pl_data->rst_pmu;
1143         ifx_dev->gpio.po = pl_data->pwr_on;
1144         ifx_dev->gpio.mrdy = pl_data->mrdy;
1145         ifx_dev->gpio.srdy = pl_data->srdy;
1146         ifx_dev->gpio.reset_out = pl_data->rst_out;
1147
1148         dev_info(&spi->dev, "gpios %d, %d, %d, %d, %d",
1149                  ifx_dev->gpio.reset, ifx_dev->gpio.po, ifx_dev->gpio.mrdy,
1150                  ifx_dev->gpio.srdy, ifx_dev->gpio.reset_out);
1151
1152         /* Configure gpios */
1153         ret = gpio_request(ifx_dev->gpio.reset, "ifxModem");
1154         if (ret < 0) {
1155                 dev_err(&spi->dev, "Unable to allocate GPIO%d (RESET)",
1156                         ifx_dev->gpio.reset);
1157                 goto error_ret;
1158         }
1159         ret += gpio_direction_output(ifx_dev->gpio.reset, 0);
1160         ret += gpio_export(ifx_dev->gpio.reset, 1);
1161         if (ret) {
1162                 dev_err(&spi->dev, "Unable to configure GPIO%d (RESET)",
1163                         ifx_dev->gpio.reset);
1164                 ret = -EBUSY;
1165                 goto error_ret2;
1166         }
1167
1168         ret = gpio_request(ifx_dev->gpio.po, "ifxModem");
1169         ret += gpio_direction_output(ifx_dev->gpio.po, 0);
1170         ret += gpio_export(ifx_dev->gpio.po, 1);
1171         if (ret) {
1172                 dev_err(&spi->dev, "Unable to configure GPIO%d (ON)",
1173                         ifx_dev->gpio.po);
1174                 ret = -EBUSY;
1175                 goto error_ret3;
1176         }
1177
1178         ret = gpio_request(ifx_dev->gpio.mrdy, "ifxModem");
1179         if (ret < 0) {
1180                 dev_err(&spi->dev, "Unable to allocate GPIO%d (MRDY)",
1181                         ifx_dev->gpio.mrdy);
1182                 goto error_ret3;
1183         }
1184         ret += gpio_export(ifx_dev->gpio.mrdy, 1);
1185         ret += gpio_direction_output(ifx_dev->gpio.mrdy, 0);
1186         if (ret) {
1187                 dev_err(&spi->dev, "Unable to configure GPIO%d (MRDY)",
1188                         ifx_dev->gpio.mrdy);
1189                 ret = -EBUSY;
1190                 goto error_ret4;
1191         }
1192
1193         ret = gpio_request(ifx_dev->gpio.srdy, "ifxModem");
1194         if (ret < 0) {
1195                 dev_err(&spi->dev, "Unable to allocate GPIO%d (SRDY)",
1196                         ifx_dev->gpio.srdy);
1197                 ret = -EBUSY;
1198                 goto error_ret4;
1199         }
1200         ret += gpio_export(ifx_dev->gpio.srdy, 1);
1201         ret += gpio_direction_input(ifx_dev->gpio.srdy);
1202         if (ret) {
1203                 dev_err(&spi->dev, "Unable to configure GPIO%d (SRDY)",
1204                         ifx_dev->gpio.srdy);
1205                 ret = -EBUSY;
1206                 goto error_ret5;
1207         }
1208
1209         ret = gpio_request(ifx_dev->gpio.reset_out, "ifxModem");
1210         if (ret < 0) {
1211                 dev_err(&spi->dev, "Unable to allocate GPIO%d (RESET_OUT)",
1212                         ifx_dev->gpio.reset_out);
1213                 goto error_ret5;
1214         }
1215         ret += gpio_export(ifx_dev->gpio.reset_out, 1);
1216         ret += gpio_direction_input(ifx_dev->gpio.reset_out);
1217         if (ret) {
1218                 dev_err(&spi->dev, "Unable to configure GPIO%d (RESET_OUT)",
1219                         ifx_dev->gpio.reset_out);
1220                 ret = -EBUSY;
1221                 goto error_ret6;
1222         }
1223
1224         ret = request_irq(gpio_to_irq(ifx_dev->gpio.reset_out),
1225                           ifx_spi_reset_interrupt,
1226                           IRQF_TRIGGER_RISING|IRQF_TRIGGER_FALLING, DRVNAME,
1227                 (void *)ifx_dev);
1228         if (ret) {
1229                 dev_err(&spi->dev, "Unable to get irq %x\n",
1230                         gpio_to_irq(ifx_dev->gpio.reset_out));
1231                 goto error_ret6;
1232         }
1233
1234         ret = ifx_spi_reset(ifx_dev);
1235
1236         ret = request_irq(gpio_to_irq(ifx_dev->gpio.srdy),
1237                           ifx_spi_srdy_interrupt,
1238                           IRQF_TRIGGER_RISING, DRVNAME,
1239                           (void *)ifx_dev);
1240         if (ret) {
1241                 dev_err(&spi->dev, "Unable to get irq %x",
1242                         gpio_to_irq(ifx_dev->gpio.srdy));
1243                 goto error_ret7;
1244         }
1245
1246         /* set pm runtime power state and register with power system */
1247         pm_runtime_set_active(&spi->dev);
1248         pm_runtime_enable(&spi->dev);
1249
1250         /* handle case that modem is already signaling SRDY */
1251         /* no outgoing tty open at this point, this just satisfies the
1252          * modem's read and should reset communication properly
1253          */
1254         srdy = gpio_get_value(ifx_dev->gpio.srdy);
1255
1256         if (srdy) {
1257                 mrdy_assert(ifx_dev);
1258                 ifx_spi_handle_srdy(ifx_dev);
1259         } else
1260                 mrdy_set_low(ifx_dev);
1261         return 0;
1262
1263 error_ret7:
1264         free_irq(gpio_to_irq(ifx_dev->gpio.reset_out), (void *)ifx_dev);
1265 error_ret6:
1266         gpio_free(ifx_dev->gpio.srdy);
1267 error_ret5:
1268         gpio_free(ifx_dev->gpio.mrdy);
1269 error_ret4:
1270         gpio_free(ifx_dev->gpio.reset);
1271 error_ret3:
1272         gpio_free(ifx_dev->gpio.po);
1273 error_ret2:
1274         gpio_free(ifx_dev->gpio.reset_out);
1275 error_ret:
1276         ifx_spi_free_device(ifx_dev);
1277         saved_ifx_dev = NULL;
1278         return ret;
1279 }
1280
1281 /**
1282  *      ifx_spi_spi_remove      -       SPI device was removed
1283  *      @spi: SPI device
1284  *
1285  *      FIXME: We should be shutting the device down here not in
1286  *      the module unload path.
1287  */
1288
1289 static int ifx_spi_spi_remove(struct spi_device *spi)
1290 {
1291         struct ifx_spi_device *ifx_dev = spi_get_drvdata(spi);
1292         /* stop activity */
1293         tasklet_kill(&ifx_dev->io_work_tasklet);
1294         /* free irq */
1295         free_irq(gpio_to_irq(ifx_dev->gpio.reset_out), (void *)ifx_dev);
1296         free_irq(gpio_to_irq(ifx_dev->gpio.srdy), (void *)ifx_dev);
1297
1298         gpio_free(ifx_dev->gpio.srdy);
1299         gpio_free(ifx_dev->gpio.mrdy);
1300         gpio_free(ifx_dev->gpio.reset);
1301         gpio_free(ifx_dev->gpio.po);
1302         gpio_free(ifx_dev->gpio.reset_out);
1303
1304         /* free allocations */
1305         ifx_spi_free_device(ifx_dev);
1306
1307         saved_ifx_dev = NULL;
1308         return 0;
1309 }
1310
1311 /**
1312  *      ifx_spi_spi_shutdown    -       called on SPI shutdown
1313  *      @spi: SPI device
1314  *
1315  *      No action needs to be taken here
1316  */
1317
1318 static void ifx_spi_spi_shutdown(struct spi_device *spi)
1319 {
1320         struct ifx_spi_device *ifx_dev = spi_get_drvdata(spi);
1321
1322         ifx_modem_power_off(ifx_dev);
1323 }
1324
1325 /*
1326  * various suspends and resumes have nothing to do
1327  * no hardware to save state for
1328  */
1329
1330 /**
1331  *      ifx_spi_spi_suspend     -       suspend SPI on system suspend
1332  *      @dev: device being suspended
1333  *
1334  *      Suspend the SPI side. No action needed on Intel MID platforms, may
1335  *      need extending for other systems.
1336  */
1337 static int ifx_spi_spi_suspend(struct spi_device *spi, pm_message_t msg)
1338 {
1339         return 0;
1340 }
1341
1342 /**
1343  *      ifx_spi_spi_resume      -       resume SPI side on system resume
1344  *      @dev: device being suspended
1345  *
1346  *      Suspend the SPI side. No action needed on Intel MID platforms, may
1347  *      need extending for other systems.
1348  */
1349 static int ifx_spi_spi_resume(struct spi_device *spi)
1350 {
1351         return 0;
1352 }
1353
1354 /**
1355  *      ifx_spi_pm_suspend      -       suspend modem on system suspend
1356  *      @dev: device being suspended
1357  *
1358  *      Suspend the modem. No action needed on Intel MID platforms, may
1359  *      need extending for other systems.
1360  */
1361 static int ifx_spi_pm_suspend(struct device *dev)
1362 {
1363         return 0;
1364 }
1365
1366 /**
1367  *      ifx_spi_pm_resume       -       resume modem on system resume
1368  *      @dev: device being suspended
1369  *
1370  *      Allow the modem to resume. No action needed.
1371  *
1372  *      FIXME: do we need to reset anything here ?
1373  */
1374 static int ifx_spi_pm_resume(struct device *dev)
1375 {
1376         return 0;
1377 }
1378
1379 /**
1380  *      ifx_spi_pm_runtime_resume       -       suspend modem
1381  *      @dev: device being suspended
1382  *
1383  *      Allow the modem to resume. No action needed.
1384  */
1385 static int ifx_spi_pm_runtime_resume(struct device *dev)
1386 {
1387         return 0;
1388 }
1389
1390 /**
1391  *      ifx_spi_pm_runtime_suspend      -       suspend modem
1392  *      @dev: device being suspended
1393  *
1394  *      Allow the modem to suspend and thus suspend to continue up the
1395  *      device tree.
1396  */
1397 static int ifx_spi_pm_runtime_suspend(struct device *dev)
1398 {
1399         return 0;
1400 }
1401
1402 /**
1403  *      ifx_spi_pm_runtime_idle         -       check if modem idle
1404  *      @dev: our device
1405  *
1406  *      Check conditions and queue runtime suspend if idle.
1407  */
1408 static int ifx_spi_pm_runtime_idle(struct device *dev)
1409 {
1410         struct spi_device *spi = to_spi_device(dev);
1411         struct ifx_spi_device *ifx_dev = spi_get_drvdata(spi);
1412
1413         if (!ifx_dev->power_status)
1414                 pm_runtime_suspend(dev);
1415
1416         return 0;
1417 }
1418
1419 static const struct dev_pm_ops ifx_spi_pm = {
1420         .resume = ifx_spi_pm_resume,
1421         .suspend = ifx_spi_pm_suspend,
1422         .runtime_resume = ifx_spi_pm_runtime_resume,
1423         .runtime_suspend = ifx_spi_pm_runtime_suspend,
1424         .runtime_idle = ifx_spi_pm_runtime_idle
1425 };
1426
1427 static const struct spi_device_id ifx_id_table[] = {
1428         {"ifx6160", 0},
1429         {"ifx6260", 0},
1430         { }
1431 };
1432 MODULE_DEVICE_TABLE(spi, ifx_id_table);
1433
1434 /* spi operations */
1435 static struct spi_driver ifx_spi_driver = {
1436         .driver = {
1437                 .name = DRVNAME,
1438                 .pm = &ifx_spi_pm,
1439                 .owner = THIS_MODULE},
1440         .probe = ifx_spi_spi_probe,
1441         .shutdown = ifx_spi_spi_shutdown,
1442         .remove = ifx_spi_spi_remove,
1443         .suspend = ifx_spi_spi_suspend,
1444         .resume = ifx_spi_spi_resume,
1445         .id_table = ifx_id_table
1446 };
1447
1448 /**
1449  *      ifx_spi_exit    -       module exit
1450  *
1451  *      Unload the module.
1452  */
1453
1454 static void __exit ifx_spi_exit(void)
1455 {
1456         /* unregister */
1457         tty_unregister_driver(tty_drv);
1458         put_tty_driver(tty_drv);
1459         spi_unregister_driver((void *)&ifx_spi_driver);
1460         unregister_reboot_notifier(&ifx_modem_reboot_notifier_block);
1461 }
1462
1463 /**
1464  *      ifx_spi_init            -       module entry point
1465  *
1466  *      Initialise the SPI and tty interfaces for the IFX SPI driver
1467  *      We need to initialize upper-edge spi driver after the tty
1468  *      driver because otherwise the spi probe will race
1469  */
1470
1471 static int __init ifx_spi_init(void)
1472 {
1473         int result;
1474
1475         tty_drv = alloc_tty_driver(1);
1476         if (!tty_drv) {
1477                 pr_err("%s: alloc_tty_driver failed", DRVNAME);
1478                 return -ENOMEM;
1479         }
1480
1481         tty_drv->driver_name = DRVNAME;
1482         tty_drv->name = TTYNAME;
1483         tty_drv->minor_start = IFX_SPI_TTY_ID;
1484         tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
1485         tty_drv->subtype = SERIAL_TYPE_NORMAL;
1486         tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1487         tty_drv->init_termios = tty_std_termios;
1488
1489         tty_set_operations(tty_drv, &ifx_spi_serial_ops);
1490
1491         result = tty_register_driver(tty_drv);
1492         if (result) {
1493                 pr_err("%s: tty_register_driver failed(%d)",
1494                         DRVNAME, result);
1495                 goto err_free_tty;
1496         }
1497
1498         result = spi_register_driver((void *)&ifx_spi_driver);
1499         if (result) {
1500                 pr_err("%s: spi_register_driver failed(%d)",
1501                         DRVNAME, result);
1502                 goto err_unreg_tty;
1503         }
1504
1505         result = register_reboot_notifier(&ifx_modem_reboot_notifier_block);
1506         if (result) {
1507                 pr_err("%s: register ifx modem reboot notifier failed(%d)",
1508                         DRVNAME, result);
1509                 goto err_unreg_spi;
1510         }
1511
1512         return 0;
1513 err_unreg_spi:
1514         spi_unregister_driver((void *)&ifx_spi_driver);
1515 err_unreg_tty:
1516         tty_unregister_driver(tty_drv);
1517 err_free_tty:
1518         put_tty_driver(tty_drv);
1519
1520         return result;
1521 }
1522
1523 module_init(ifx_spi_init);
1524 module_exit(ifx_spi_exit);
1525
1526 MODULE_AUTHOR("Intel");
1527 MODULE_DESCRIPTION("IFX6x60 spi driver");
1528 MODULE_LICENSE("GPL");
1529 MODULE_INFO(Version, "0.1-IFX6x60");