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