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         port->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         tty_insert_flip_string(&ifx_dev->tty_port, chars, size);
 673         tty_flip_buffer_push(&ifx_dev->tty_port);
 674 }
 675
 676 /**
 677  *      ifx_spi_complete        -       SPI transfer completed
 678  *      @ctx: our SPI device
 679  *
 680  *      An SPI transfer has completed. Process any received data and kick off
 681  *      any further transmits we can commence.
 682  */
 683 static void ifx_spi_complete(void *ctx)
 684 {
 685         struct ifx_spi_device *ifx_dev = ctx;
 686         struct tty_struct *tty;
 687         struct tty_ldisc *ldisc = NULL;
 688         int length;
 689         int actual_length;
 690         unsigned char more;
 691         unsigned char cts;
 692         int local_write_pending = 0;
 693         int queue_length;
 694         int srdy;
 695         int decode_result;
 696
 697         mrdy_set_low(ifx_dev);
 698
 699         if (!ifx_dev->spi_msg.status) {
 700                 /* check header validity, get comm flags */
 701                 ifx_dev->swap_buf(ifx_dev->rx_buffer, IFX_SPI_HEADER_OVERHEAD,
 702                         &ifx_dev->rx_buffer[IFX_SPI_HEADER_OVERHEAD]);
 703                 decode_result = ifx_spi_decode_spi_header(ifx_dev->rx_buffer,
 704                                 &length, &more, &cts);
 705                 if (decode_result == IFX_SPI_HEADER_0) {
 706                         dev_dbg(&ifx_dev->spi_dev->dev,
 707                                 "ignore input: invalid header 0");
 708                         ifx_dev->spi_slave_cts = 0;
 709                         goto complete_exit;
 710                 } else if (decode_result == IFX_SPI_HEADER_F) {
 711                         dev_dbg(&ifx_dev->spi_dev->dev,
 712                                 "ignore input: invalid header F");
 713                         goto complete_exit;
 714                 }
 715
 716                 ifx_dev->spi_slave_cts = cts;
 717
 718                 actual_length = min((unsigned int)length,
 719                                         ifx_dev->spi_msg.actual_length);
 720                 ifx_dev->swap_buf(
 721                         (ifx_dev->rx_buffer + IFX_SPI_HEADER_OVERHEAD),
 722                          actual_length,
 723                          &ifx_dev->rx_buffer[IFX_SPI_TRANSFER_SIZE]);
 724                 ifx_spi_insert_flip_string(
 725                         ifx_dev,
 726                         ifx_dev->rx_buffer + IFX_SPI_HEADER_OVERHEAD,
 727                         (size_t)actual_length);
 728         } else {
 729                 dev_dbg(&ifx_dev->spi_dev->dev, "SPI transfer error %d",
 730                        ifx_dev->spi_msg.status);
 731         }
 732
 733 complete_exit:
 734         if (ifx_dev->write_pending) {
 735                 ifx_dev->write_pending = 0;
 736                 local_write_pending = 1;
 737         }
 738
 739         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &(ifx_dev->flags));
 740
 741         queue_length = kfifo_len(&ifx_dev->tx_fifo);
 742         srdy = gpio_get_value(ifx_dev->gpio.srdy);
 743         if (!srdy)
 744                 ifx_spi_power_state_clear(ifx_dev, IFX_SPI_POWER_SRDY);
 745
 746         /* schedule output if there is more to do */
 747         if (test_and_clear_bit(IFX_SPI_STATE_IO_READY, &ifx_dev->flags))
 748                 tasklet_schedule(&ifx_dev->io_work_tasklet);
 749         else {
 750                 if (more || ifx_dev->spi_more || queue_length > 0 ||
 751                         local_write_pending) {
 752                         if (ifx_dev->spi_slave_cts) {
 753                                 if (more)
 754                                         mrdy_assert(ifx_dev);
 755                         } else
 756                                 mrdy_assert(ifx_dev);
 757                 } else {
 758                         /*
 759                          * poke line discipline driver if any for more data
 760                          * may or may not get more data to write
 761                          * for now, say not busy
 762                          */
 763                         ifx_spi_power_state_clear(ifx_dev,
 764                                                   IFX_SPI_POWER_DATA_PENDING);
 765                         tty = tty_port_tty_get(&ifx_dev->tty_port);
 766                         if (tty) {
 767                                 ldisc = tty_ldisc_ref(tty);
 768                                 if (ldisc) {
 769                                         ldisc->ops->write_wakeup(tty);
 770                                         tty_ldisc_deref(ldisc);
 771                                 }
 772                                 tty_kref_put(tty);
 773                         }
 774                 }
 775         }
 776 }
 777
 778 /**
 779  *      ifx_spio_io             -       I/O tasklet
 780  *      @data: our SPI device
 781  *
 782  *      Queue data for transmission if possible and then kick off the
 783  *      transfer.
 784  */
 785 static void ifx_spi_io(unsigned long data)
 786 {
 787         int retval;
 788         struct ifx_spi_device *ifx_dev = (struct ifx_spi_device *) data;
 789
 790         if (!test_and_set_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags) &&
 791                 test_bit(IFX_SPI_STATE_IO_AVAILABLE, &ifx_dev->flags)) {
 792                 if (ifx_dev->gpio.unack_srdy_int_nb > 0)
 793                         ifx_dev->gpio.unack_srdy_int_nb--;
 794
 795                 ifx_spi_prepare_tx_buffer(ifx_dev);
 796
 797                 spi_message_init(&ifx_dev->spi_msg);
 798                 INIT_LIST_HEAD(&ifx_dev->spi_msg.queue);
 799
 800                 ifx_dev->spi_msg.context = ifx_dev;
 801                 ifx_dev->spi_msg.complete = ifx_spi_complete;
 802
 803                 /* set up our spi transfer */
 804                 /* note len is BYTES, not transfers */
 805                 ifx_dev->spi_xfer.len = IFX_SPI_TRANSFER_SIZE;
 806                 ifx_dev->spi_xfer.cs_change = 0;
 807                 ifx_dev->spi_xfer.speed_hz = ifx_dev->spi_dev->max_speed_hz;
 808                 /* ifx_dev->spi_xfer.speed_hz = 390625; */
 809                 ifx_dev->spi_xfer.bits_per_word = spi_bpw;
 810
 811                 ifx_dev->spi_xfer.tx_buf = ifx_dev->tx_buffer;
 812                 ifx_dev->spi_xfer.rx_buf = ifx_dev->rx_buffer;
 813
 814                 /*
 815                  * setup dma pointers
 816                  */
 817                 if (ifx_dev->use_dma) {
 818                         ifx_dev->spi_msg.is_dma_mapped = 1;
 819                         ifx_dev->tx_dma = ifx_dev->tx_bus;
 820                         ifx_dev->rx_dma = ifx_dev->rx_bus;
 821                         ifx_dev->spi_xfer.tx_dma = ifx_dev->tx_dma;
 822                         ifx_dev->spi_xfer.rx_dma = ifx_dev->rx_dma;
 823                 } else {
 824                         ifx_dev->spi_msg.is_dma_mapped = 0;
 825                         ifx_dev->tx_dma = (dma_addr_t)0;
 826                         ifx_dev->rx_dma = (dma_addr_t)0;
 827                         ifx_dev->spi_xfer.tx_dma = (dma_addr_t)0;
 828                         ifx_dev->spi_xfer.rx_dma = (dma_addr_t)0;
 829                 }
 830
 831                 spi_message_add_tail(&ifx_dev->spi_xfer, &ifx_dev->spi_msg);
 832
 833                 /* Assert MRDY. This may have already been done by the write
 834                  * routine.
 835                  */
 836                 mrdy_assert(ifx_dev);
 837
 838                 retval = spi_async(ifx_dev->spi_dev, &ifx_dev->spi_msg);
 839                 if (retval) {
 840                         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS,
 841                                   &ifx_dev->flags);
 842                         tasklet_schedule(&ifx_dev->io_work_tasklet);
 843                         return;
 844                 }
 845         } else
 846                 ifx_dev->write_pending = 1;
 847 }
 848
 849 /**
 850  *      ifx_spi_free_port       -       free up the tty side
 851  *      @ifx_dev: IFX device going away
 852  *
 853  *      Unregister and free up a port when the device goes away
 854  */
 855 static void ifx_spi_free_port(struct ifx_spi_device *ifx_dev)
 856 {
 857         if (ifx_dev->tty_dev)
 858                 tty_unregister_device(tty_drv, ifx_dev->minor);
 859         tty_port_destroy(&ifx_dev->tty_port);
 860         kfifo_free(&ifx_dev->tx_fifo);
 861 }
 862
 863 /**
 864  *      ifx_spi_create_port     -       create a new port
 865  *      @ifx_dev: our spi device
 866  *
 867  *      Allocate and initialise the tty port that goes with this interface
 868  *      and add it to the tty layer so that it can be opened.
 869  */
 870 static int ifx_spi_create_port(struct ifx_spi_device *ifx_dev)
 871 {
 872         int ret = 0;
 873         struct tty_port *pport = &ifx_dev->tty_port;
 874
 875         spin_lock_init(&ifx_dev->fifo_lock);
 876         lockdep_set_class_and_subclass(&ifx_dev->fifo_lock,
 877                 &ifx_spi_key, 0);
 878
 879         if (kfifo_alloc(&ifx_dev->tx_fifo, IFX_SPI_FIFO_SIZE, GFP_KERNEL)) {
 880                 ret = -ENOMEM;
 881                 goto error_ret;
 882         }
 883
 884         tty_port_init(pport);
 885         pport->ops = &ifx_tty_port_ops;
 886         ifx_dev->minor = IFX_SPI_TTY_ID;
 887         ifx_dev->tty_dev = tty_port_register_device(pport, tty_drv,
 888                         ifx_dev->minor, &ifx_dev->spi_dev->dev);
 889         if (IS_ERR(ifx_dev->tty_dev)) {
 890                 dev_dbg(&ifx_dev->spi_dev->dev,
 891                         "%s: registering tty device failed", __func__);
 892                 ret = PTR_ERR(ifx_dev->tty_dev);
 893                 goto error_port;
 894         }
 895         return 0;
 896
 897 error_port:
 898         tty_port_destroy(pport);
 899 error_ret:
 900         ifx_spi_free_port(ifx_dev);
 901         return ret;
 902 }
 903
 904 /**
 905  *      ifx_spi_handle_srdy             -       handle SRDY
 906  *      @ifx_dev: device asserting SRDY
 907  *
 908  *      Check our device state and see what we need to kick off when SRDY
 909  *      is asserted. This usually means killing the timer and firing off the
 910  *      I/O processing.
 911  */
 912 static void ifx_spi_handle_srdy(struct ifx_spi_device *ifx_dev)
 913 {
 914         if (test_bit(IFX_SPI_STATE_TIMER_PENDING, &ifx_dev->flags)) {
 915                 del_timer(&ifx_dev->spi_timer);
 916                 clear_bit(IFX_SPI_STATE_TIMER_PENDING, &ifx_dev->flags);
 917         }
 918
 919         ifx_spi_power_state_set(ifx_dev, IFX_SPI_POWER_SRDY);
 920
 921         if (!test_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags))
 922                 tasklet_schedule(&ifx_dev->io_work_tasklet);
 923         else
 924                 set_bit(IFX_SPI_STATE_IO_READY, &ifx_dev->flags);
 925 }
 926
 927 /**
 928  *      ifx_spi_srdy_interrupt  -       SRDY asserted
 929  *      @irq: our IRQ number
 930  *      @dev: our ifx device
 931  *
 932  *      The modem asserted SRDY. Handle the srdy event
 933  */
 934 static irqreturn_t ifx_spi_srdy_interrupt(int irq, void *dev)
 935 {
 936         struct ifx_spi_device *ifx_dev = dev;
 937         ifx_dev->gpio.unack_srdy_int_nb++;
 938         ifx_spi_handle_srdy(ifx_dev);
 939         return IRQ_HANDLED;
 940 }
 941
 942 /**
 943  *      ifx_spi_reset_interrupt -       Modem has changed reset state
 944  *      @irq: interrupt number
 945  *      @dev: our device pointer
 946  *
 947  *      The modem has either entered or left reset state. Check the GPIO
 948  *      line to see which.
 949  *
 950  *      FIXME: review locking on MR_INPROGRESS versus
 951  *      parallel unsolicited reset/solicited reset
 952  */
 953 static irqreturn_t ifx_spi_reset_interrupt(int irq, void *dev)
 954 {
 955         struct ifx_spi_device *ifx_dev = dev;
 956         int val = gpio_get_value(ifx_dev->gpio.reset_out);
 957         int solreset = test_bit(MR_START, &ifx_dev->mdm_reset_state);
 958
 959         if (val == 0) {
 960                 /* entered reset */
 961                 set_bit(MR_INPROGRESS, &ifx_dev->mdm_reset_state);
 962                 if (!solreset) {
 963                         /* unsolicited reset  */
 964                         ifx_spi_ttyhangup(ifx_dev);
 965                 }
 966         } else {
 967                 /* exited reset */
 968                 clear_bit(MR_INPROGRESS, &ifx_dev->mdm_reset_state);
 969                 if (solreset) {
 970                         set_bit(MR_COMPLETE, &ifx_dev->mdm_reset_state);
 971                         wake_up(&ifx_dev->mdm_reset_wait);
 972                 }
 973         }
 974         return IRQ_HANDLED;
 975 }
 976
 977 /**
 978  *      ifx_spi_free_device - free device
 979  *      @ifx_dev: device to free
 980  *
 981  *      Free the IFX device
 982  */
 983 static void ifx_spi_free_device(struct ifx_spi_device *ifx_dev)
 984 {
 985         ifx_spi_free_port(ifx_dev);
 986         dma_free_coherent(&ifx_dev->spi_dev->dev,
 987                                 IFX_SPI_TRANSFER_SIZE,
 988                                 ifx_dev->tx_buffer,
 989                                 ifx_dev->tx_bus);
 990         dma_free_coherent(&ifx_dev->spi_dev->dev,
 991                                 IFX_SPI_TRANSFER_SIZE,
 992                                 ifx_dev->rx_buffer,
 993                                 ifx_dev->rx_bus);
 994 }
 995
 996 /**
 997  *      ifx_spi_reset   -       reset modem
 998  *      @ifx_dev: modem to reset
 999  *
1000  *      Perform a reset on the modem
1001  */
1002 static int ifx_spi_reset(struct ifx_spi_device *ifx_dev)
1003 {
1004         int ret;
1005         /*
1006          * set up modem power, reset
1007          *
1008          * delays are required on some platforms for the modem
1009          * to reset properly
1010          */
1011         set_bit(MR_START, &ifx_dev->mdm_reset_state);
1012         gpio_set_value(ifx_dev->gpio.po, 0);
1013         gpio_set_value(ifx_dev->gpio.reset, 0);
1014         msleep(25);
1015         gpio_set_value(ifx_dev->gpio.reset, 1);
1016         msleep(1);
1017         gpio_set_value(ifx_dev->gpio.po, 1);
1018         msleep(1);
1019         gpio_set_value(ifx_dev->gpio.po, 0);
1020         ret = wait_event_timeout(ifx_dev->mdm_reset_wait,
1021                                  test_bit(MR_COMPLETE,
1022                                           &ifx_dev->mdm_reset_state),
1023                                  IFX_RESET_TIMEOUT);
1024         if (!ret)
1025                 dev_warn(&ifx_dev->spi_dev->dev, "Modem reset timeout: (state:%lx)",
1026                          ifx_dev->mdm_reset_state);
1027
1028         ifx_dev->mdm_reset_state = 0;
1029         return ret;
1030 }
1031
1032 /**
1033  *      ifx_spi_spi_probe       -       probe callback
1034  *      @spi: our possible matching SPI device
1035  *
1036  *      Probe for a 6x60 modem on SPI bus. Perform any needed device and
1037  *      GPIO setup.
1038  *
1039  *      FIXME:
1040  *      -       Support for multiple devices
1041  *      -       Split out MID specific GPIO handling eventually
1042  */
1043
1044 static int ifx_spi_spi_probe(struct spi_device *spi)
1045 {
1046         int ret;
1047         int srdy;
1048         struct ifx_modem_platform_data *pl_data;
1049         struct ifx_spi_device *ifx_dev;
1050
1051         if (saved_ifx_dev) {
1052                 dev_dbg(&spi->dev, "ignoring subsequent detection");
1053                 return -ENODEV;
1054         }
1055
1056         pl_data = (struct ifx_modem_platform_data *)spi->dev.platform_data;
1057         if (!pl_data) {
1058                 dev_err(&spi->dev, "missing platform data!");
1059                 return -ENODEV;
1060         }
1061
1062         /* initialize structure to hold our device variables */
1063         ifx_dev = kzalloc(sizeof(struct ifx_spi_device), GFP_KERNEL);
1064         if (!ifx_dev) {
1065                 dev_err(&spi->dev, "spi device allocation failed");
1066                 return -ENOMEM;
1067         }
1068         saved_ifx_dev = ifx_dev;
1069         ifx_dev->spi_dev = spi;
1070         clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS, &ifx_dev->flags);
1071         spin_lock_init(&ifx_dev->write_lock);
1072         spin_lock_init(&ifx_dev->power_lock);
1073         ifx_dev->power_status = 0;
1074         init_timer(&ifx_dev->spi_timer);
1075         ifx_dev->spi_timer.function = ifx_spi_timeout;
1076         ifx_dev->spi_timer.data = (unsigned long)ifx_dev;
1077         ifx_dev->modem = pl_data->modem_type;
1078         ifx_dev->use_dma = pl_data->use_dma;
1079         ifx_dev->max_hz = pl_data->max_hz;
1080         /* initialize spi mode, etc */
1081         spi->max_speed_hz = ifx_dev->max_hz;
1082         spi->mode = IFX_SPI_MODE | (SPI_LOOP & spi->mode);
1083         spi->bits_per_word = spi_bpw;
1084         ret = spi_setup(spi);
1085         if (ret) {
1086                 dev_err(&spi->dev, "SPI setup wasn't successful %d", ret);
1087                 return -ENODEV;
1088         }
1089
1090         /* init swap_buf function according to word width configuration */
1091         if (spi->bits_per_word == 32)
1092                 ifx_dev->swap_buf = swap_buf_32;
1093         else if (spi->bits_per_word == 16)
1094                 ifx_dev->swap_buf = swap_buf_16;
1095         else
1096                 ifx_dev->swap_buf = swap_buf_8;
1097
1098         /* ensure SPI protocol flags are initialized to enable transfer */
1099         ifx_dev->spi_more = 0;
1100         ifx_dev->spi_slave_cts = 0;
1101
1102         /*initialize transfer and dma buffers */
1103         ifx_dev->tx_buffer = dma_alloc_coherent(ifx_dev->spi_dev->dev.parent,
1104                                 IFX_SPI_TRANSFER_SIZE,
1105                                 &ifx_dev->tx_bus,
1106                                 GFP_KERNEL);
1107         if (!ifx_dev->tx_buffer) {
1108                 dev_err(&spi->dev, "DMA-TX buffer allocation failed");
1109                 ret = -ENOMEM;
1110                 goto error_ret;
1111         }
1112         ifx_dev->rx_buffer = dma_alloc_coherent(ifx_dev->spi_dev->dev.parent,
1113                                 IFX_SPI_TRANSFER_SIZE,
1114                                 &ifx_dev->rx_bus,
1115                                 GFP_KERNEL);
1116         if (!ifx_dev->rx_buffer) {
1117                 dev_err(&spi->dev, "DMA-RX buffer allocation failed");
1118                 ret = -ENOMEM;
1119                 goto error_ret;
1120         }
1121
1122         /* initialize waitq for modem reset */
1123         init_waitqueue_head(&ifx_dev->mdm_reset_wait);
1124
1125         spi_set_drvdata(spi, ifx_dev);
1126         tasklet_init(&ifx_dev->io_work_tasklet, ifx_spi_io,
1127                                                 (unsigned long)ifx_dev);
1128
1129         set_bit(IFX_SPI_STATE_PRESENT, &ifx_dev->flags);
1130
1131         /* create our tty port */
1132         ret = ifx_spi_create_port(ifx_dev);
1133         if (ret != 0) {
1134                 dev_err(&spi->dev, "create default tty port failed");
1135                 goto error_ret;
1136         }
1137
1138         ifx_dev->gpio.reset = pl_data->rst_pmu;
1139         ifx_dev->gpio.po = pl_data->pwr_on;
1140         ifx_dev->gpio.mrdy = pl_data->mrdy;
1141         ifx_dev->gpio.srdy = pl_data->srdy;
1142         ifx_dev->gpio.reset_out = pl_data->rst_out;
1143
1144         dev_info(&spi->dev, "gpios %d, %d, %d, %d, %d",
1145                  ifx_dev->gpio.reset, ifx_dev->gpio.po, ifx_dev->gpio.mrdy,
1146                  ifx_dev->gpio.srdy, ifx_dev->gpio.reset_out);
1147
1148         /* Configure gpios */
1149         ret = gpio_request(ifx_dev->gpio.reset, "ifxModem");
1150         if (ret < 0) {
1151                 dev_err(&spi->dev, "Unable to allocate GPIO%d (RESET)",
1152                         ifx_dev->gpio.reset);
1153                 goto error_ret;
1154         }
1155         ret += gpio_direction_output(ifx_dev->gpio.reset, 0);
1156         ret += gpio_export(ifx_dev->gpio.reset, 1);
1157         if (ret) {
1158                 dev_err(&spi->dev, "Unable to configure GPIO%d (RESET)",
1159                         ifx_dev->gpio.reset);
1160                 ret = -EBUSY;
1161                 goto error_ret2;
1162         }
1163
1164         ret = gpio_request(ifx_dev->gpio.po, "ifxModem");
1165         ret += gpio_direction_output(ifx_dev->gpio.po, 0);
1166         ret += gpio_export(ifx_dev->gpio.po, 1);
1167         if (ret) {
1168                 dev_err(&spi->dev, "Unable to configure GPIO%d (ON)",
1169                         ifx_dev->gpio.po);
1170                 ret = -EBUSY;
1171                 goto error_ret3;
1172         }
1173
1174         ret = gpio_request(ifx_dev->gpio.mrdy, "ifxModem");
1175         if (ret < 0) {
1176                 dev_err(&spi->dev, "Unable to allocate GPIO%d (MRDY)",
1177                         ifx_dev->gpio.mrdy);
1178                 goto error_ret3;
1179         }
1180         ret += gpio_export(ifx_dev->gpio.mrdy, 1);
1181         ret += gpio_direction_output(ifx_dev->gpio.mrdy, 0);
1182         if (ret) {
1183                 dev_err(&spi->dev, "Unable to configure GPIO%d (MRDY)",
1184                         ifx_dev->gpio.mrdy);
1185                 ret = -EBUSY;
1186                 goto error_ret4;
1187         }
1188
1189         ret = gpio_request(ifx_dev->gpio.srdy, "ifxModem");
1190         if (ret < 0) {
1191                 dev_err(&spi->dev, "Unable to allocate GPIO%d (SRDY)",
1192                         ifx_dev->gpio.srdy);
1193                 ret = -EBUSY;
1194                 goto error_ret4;
1195         }
1196         ret += gpio_export(ifx_dev->gpio.srdy, 1);
1197         ret += gpio_direction_input(ifx_dev->gpio.srdy);
1198         if (ret) {
1199                 dev_err(&spi->dev, "Unable to configure GPIO%d (SRDY)",
1200                         ifx_dev->gpio.srdy);
1201                 ret = -EBUSY;
1202                 goto error_ret5;
1203         }
1204
1205         ret = gpio_request(ifx_dev->gpio.reset_out, "ifxModem");
1206         if (ret < 0) {
1207                 dev_err(&spi->dev, "Unable to allocate GPIO%d (RESET_OUT)",
1208                         ifx_dev->gpio.reset_out);
1209                 goto error_ret5;
1210         }
1211         ret += gpio_export(ifx_dev->gpio.reset_out, 1);
1212         ret += gpio_direction_input(ifx_dev->gpio.reset_out);
1213         if (ret) {
1214                 dev_err(&spi->dev, "Unable to configure GPIO%d (RESET_OUT)",
1215                         ifx_dev->gpio.reset_out);
1216                 ret = -EBUSY;
1217                 goto error_ret6;
1218         }
1219
1220         ret = request_irq(gpio_to_irq(ifx_dev->gpio.reset_out),
1221                           ifx_spi_reset_interrupt,
1222                           IRQF_TRIGGER_RISING|IRQF_TRIGGER_FALLING, DRVNAME,
1223                 (void *)ifx_dev);
1224         if (ret) {
1225                 dev_err(&spi->dev, "Unable to get irq %x\n",
1226                         gpio_to_irq(ifx_dev->gpio.reset_out));
1227                 goto error_ret6;
1228         }
1229
1230         ret = ifx_spi_reset(ifx_dev);
1231
1232         ret = request_irq(gpio_to_irq(ifx_dev->gpio.srdy),
1233                           ifx_spi_srdy_interrupt,
1234                           IRQF_TRIGGER_RISING, DRVNAME,
1235                           (void *)ifx_dev);
1236         if (ret) {
1237                 dev_err(&spi->dev, "Unable to get irq %x",
1238                         gpio_to_irq(ifx_dev->gpio.srdy));
1239                 goto error_ret7;
1240         }
1241
1242         /* set pm runtime power state and register with power system */
1243         pm_runtime_set_active(&spi->dev);
1244         pm_runtime_enable(&spi->dev);
1245
1246         /* handle case that modem is already signaling SRDY */
1247         /* no outgoing tty open at this point, this just satisfies the
1248          * modem's read and should reset communication properly
1249          */
1250         srdy = gpio_get_value(ifx_dev->gpio.srdy);
1251
1252         if (srdy) {
1253                 mrdy_assert(ifx_dev);
1254                 ifx_spi_handle_srdy(ifx_dev);
1255         } else
1256                 mrdy_set_low(ifx_dev);
1257         return 0;
1258
1259 error_ret7:
1260         free_irq(gpio_to_irq(ifx_dev->gpio.reset_out), (void *)ifx_dev);
1261 error_ret6:
1262         gpio_free(ifx_dev->gpio.srdy);
1263 error_ret5:
1264         gpio_free(ifx_dev->gpio.mrdy);
1265 error_ret4:
1266         gpio_free(ifx_dev->gpio.reset);
1267 error_ret3:
1268         gpio_free(ifx_dev->gpio.po);
1269 error_ret2:
1270         gpio_free(ifx_dev->gpio.reset_out);
1271 error_ret:
1272         ifx_spi_free_device(ifx_dev);
1273         saved_ifx_dev = NULL;
1274         return ret;
1275 }
1276
1277 /**
1278  *      ifx_spi_spi_remove      -       SPI device was removed
1279  *      @spi: SPI device
1280  *
1281  *      FIXME: We should be shutting the device down here not in
1282  *      the module unload path.
1283  */
1284
1285 static int ifx_spi_spi_remove(struct spi_device *spi)
1286 {
1287         struct ifx_spi_device *ifx_dev = spi_get_drvdata(spi);
1288         /* stop activity */
1289         tasklet_kill(&ifx_dev->io_work_tasklet);
1290         /* free irq */
1291         free_irq(gpio_to_irq(ifx_dev->gpio.reset_out), (void *)ifx_dev);
1292         free_irq(gpio_to_irq(ifx_dev->gpio.srdy), (void *)ifx_dev);
1293
1294         gpio_free(ifx_dev->gpio.srdy);
1295         gpio_free(ifx_dev->gpio.mrdy);
1296         gpio_free(ifx_dev->gpio.reset);
1297         gpio_free(ifx_dev->gpio.po);
1298         gpio_free(ifx_dev->gpio.reset_out);
1299
1300         /* free allocations */
1301         ifx_spi_free_device(ifx_dev);
1302
1303         saved_ifx_dev = NULL;
1304         return 0;
1305 }
1306
1307 /**
1308  *      ifx_spi_spi_shutdown    -       called on SPI shutdown
1309  *      @spi: SPI device
1310  *
1311  *      No action needs to be taken here
1312  */
1313
1314 static void ifx_spi_spi_shutdown(struct spi_device *spi)
1315 {
1316         struct ifx_spi_device *ifx_dev = spi_get_drvdata(spi);
1317
1318         ifx_modem_power_off(ifx_dev);
1319 }
1320
1321 /*
1322  * various suspends and resumes have nothing to do
1323  * no hardware to save state for
1324  */
1325
1326 /**
1327  *      ifx_spi_spi_suspend     -       suspend SPI on system suspend
1328  *      @dev: device being suspended
1329  *
1330  *      Suspend the SPI side. No action needed on Intel MID platforms, may
1331  *      need extending for other systems.
1332  */
1333 static int ifx_spi_spi_suspend(struct spi_device *spi, pm_message_t msg)
1334 {
1335         return 0;
1336 }
1337
1338 /**
1339  *      ifx_spi_spi_resume      -       resume SPI side on system resume
1340  *      @dev: device being suspended
1341  *
1342  *      Suspend the SPI side. No action needed on Intel MID platforms, may
1343  *      need extending for other systems.
1344  */
1345 static int ifx_spi_spi_resume(struct spi_device *spi)
1346 {
1347         return 0;
1348 }
1349
1350 /**
1351  *      ifx_spi_pm_suspend      -       suspend modem on system suspend
1352  *      @dev: device being suspended
1353  *
1354  *      Suspend the modem. No action needed on Intel MID platforms, may
1355  *      need extending for other systems.
1356  */
1357 static int ifx_spi_pm_suspend(struct device *dev)
1358 {
1359         return 0;
1360 }
1361
1362 /**
1363  *      ifx_spi_pm_resume       -       resume modem on system resume
1364  *      @dev: device being suspended
1365  *
1366  *      Allow the modem to resume. No action needed.
1367  *
1368  *      FIXME: do we need to reset anything here ?
1369  */
1370 static int ifx_spi_pm_resume(struct device *dev)
1371 {
1372         return 0;
1373 }
1374
1375 /**
1376  *      ifx_spi_pm_runtime_resume       -       suspend modem
1377  *      @dev: device being suspended
1378  *
1379  *      Allow the modem to resume. No action needed.
1380  */
1381 static int ifx_spi_pm_runtime_resume(struct device *dev)
1382 {
1383         return 0;
1384 }
1385
1386 /**
1387  *      ifx_spi_pm_runtime_suspend      -       suspend modem
1388  *      @dev: device being suspended
1389  *
1390  *      Allow the modem to suspend and thus suspend to continue up the
1391  *      device tree.
1392  */
1393 static int ifx_spi_pm_runtime_suspend(struct device *dev)
1394 {
1395         return 0;
1396 }
1397
1398 /**
1399  *      ifx_spi_pm_runtime_idle         -       check if modem idle
1400  *      @dev: our device
1401  *
1402  *      Check conditions and queue runtime suspend if idle.
1403  */
1404 static int ifx_spi_pm_runtime_idle(struct device *dev)
1405 {
1406         struct spi_device *spi = to_spi_device(dev);
1407         struct ifx_spi_device *ifx_dev = spi_get_drvdata(spi);
1408
1409         if (!ifx_dev->power_status)
1410                 pm_runtime_suspend(dev);
1411
1412         return 0;
1413 }
1414
1415 static const struct dev_pm_ops ifx_spi_pm = {
1416         .resume = ifx_spi_pm_resume,
1417         .suspend = ifx_spi_pm_suspend,
1418         .runtime_resume = ifx_spi_pm_runtime_resume,
1419         .runtime_suspend = ifx_spi_pm_runtime_suspend,
1420         .runtime_idle = ifx_spi_pm_runtime_idle
1421 };
1422
1423 static const struct spi_device_id ifx_id_table[] = {
1424         {"ifx6160", 0},
1425         {"ifx6260", 0},
1426         { }
1427 };
1428 MODULE_DEVICE_TABLE(spi, ifx_id_table);
1429
1430 /* spi operations */
1431 static struct spi_driver ifx_spi_driver = {
1432         .driver = {
1433                 .name = DRVNAME,
1434                 .pm = &ifx_spi_pm,
1435                 .owner = THIS_MODULE},
1436         .probe = ifx_spi_spi_probe,
1437         .shutdown = ifx_spi_spi_shutdown,
1438         .remove = ifx_spi_spi_remove,
1439         .suspend = ifx_spi_spi_suspend,
1440         .resume = ifx_spi_spi_resume,
1441         .id_table = ifx_id_table
1442 };
1443
1444 /**
1445  *      ifx_spi_exit    -       module exit
1446  *
1447  *      Unload the module.
1448  */
1449
1450 static void __exit ifx_spi_exit(void)
1451 {
1452         /* unregister */
1453         tty_unregister_driver(tty_drv);
1454         put_tty_driver(tty_drv);
1455         spi_unregister_driver((void *)&ifx_spi_driver);
1456         unregister_reboot_notifier(&ifx_modem_reboot_notifier_block);
1457 }
1458
1459 /**
1460  *      ifx_spi_init            -       module entry point
1461  *
1462  *      Initialise the SPI and tty interfaces for the IFX SPI driver
1463  *      We need to initialize upper-edge spi driver after the tty
1464  *      driver because otherwise the spi probe will race
1465  */
1466
1467 static int __init ifx_spi_init(void)
1468 {
1469         int result;
1470
1471         tty_drv = alloc_tty_driver(1);
1472         if (!tty_drv) {
1473                 pr_err("%s: alloc_tty_driver failed", DRVNAME);
1474                 return -ENOMEM;
1475         }
1476
1477         tty_drv->driver_name = DRVNAME;
1478         tty_drv->name = TTYNAME;
1479         tty_drv->minor_start = IFX_SPI_TTY_ID;
1480         tty_drv->type = TTY_DRIVER_TYPE_SERIAL;
1481         tty_drv->subtype = SERIAL_TYPE_NORMAL;
1482         tty_drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1483         tty_drv->init_termios = tty_std_termios;
1484
1485         tty_set_operations(tty_drv, &ifx_spi_serial_ops);
1486
1487         result = tty_register_driver(tty_drv);
1488         if (result) {
1489                 pr_err("%s: tty_register_driver failed(%d)",
1490                         DRVNAME, result);
1491                 goto err_free_tty;
1492         }
1493
1494         result = spi_register_driver((void *)&ifx_spi_driver);
1495         if (result) {
1496                 pr_err("%s: spi_register_driver failed(%d)",
1497                         DRVNAME, result);
1498                 goto err_unreg_tty;
1499         }
1500
1501         result = register_reboot_notifier(&ifx_modem_reboot_notifier_block);
1502         if (result) {
1503                 pr_err("%s: register ifx modem reboot notifier failed(%d)",
1504                         DRVNAME, result);
1505                 goto err_unreg_spi;
1506         }
1507
1508         return 0;
1509 err_unreg_spi:
1510         spi_unregister_driver((void *)&ifx_spi_driver);
1511 err_unreg_tty:
1512         tty_unregister_driver(tty_drv);
1513 err_free_tty:
1514         put_tty_driver(tty_drv);
1515
1516         return result;
1517 }
1518
1519 module_init(ifx_spi_init);
1520 module_exit(ifx_spi_exit);
1521
1522 MODULE_AUTHOR("Intel");
1523 MODULE_DESCRIPTION("IFX6x60 spi driver");
1524 MODULE_LICENSE("GPL");
1525 MODULE_INFO(Version, "0.1-IFX6x60");