1 /****************************************************************************
3 * Driver for the IFX 6x60 spi modem.
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>
10 * Copyright (C) 2009, 2010 Intel Corp
11 * Russ Gorby <richardx.r.gorby@intel.com>
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.
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.
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,
27 * Driver modified by Intel from Option gtm501l_spi.c
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.
38 *****************************************************************************/
39 #include <linux/module.h>
40 #include <linux/termios.h>
41 #include <linux/tty.h>
42 #include <linux/device.h>
43 #include <linux/spi/spi.h>
44 #include <linux/tty.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>
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/tty.h>
61 #include <linux/pm_runtime.h>
62 #include <linux/spi/ifx_modem.h>
63 #include <linux/delay.h>
67 #define IFX_SPI_MORE_MASK 0x10
68 #define IFX_SPI_MORE_BIT 12 /* bit position in u16 */
69 #define IFX_SPI_CTS_BIT 13 /* bit position in u16 */
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)
75 /* forward reference */
76 static void ifx_spi_handle_srdy(struct ifx_spi_device
*ifx_dev
);
79 static int spi_b16
= 1; /* 8 or 16 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
;
84 /* GPIO/GPE settings */
87 * mrdy_set_high - set MRDY GPIO
88 * @ifx: device we are controlling
91 static inline void mrdy_set_high(struct ifx_spi_device
*ifx
)
93 gpio_set_value(ifx
->gpio
.mrdy
, 1);
97 * mrdy_set_low - clear MRDY GPIO
98 * @ifx: device we are controlling
101 static inline void mrdy_set_low(struct ifx_spi_device
*ifx
)
103 gpio_set_value(ifx
->gpio
.mrdy
, 0);
107 * ifx_spi_power_state_set
108 * @ifx_dev: our SPI device
111 * Set bit in power status and signal power system if status becomes non-0
114 ifx_spi_power_state_set(struct ifx_spi_device
*ifx_dev
, unsigned char val
)
118 spin_lock_irqsave(&ifx_dev
->power_lock
, flags
);
121 * if power status is already non-0, just update, else
124 if (!ifx_dev
->power_status
)
125 pm_runtime_get(&ifx_dev
->spi_dev
->dev
);
126 ifx_dev
->power_status
|= val
;
128 spin_unlock_irqrestore(&ifx_dev
->power_lock
, flags
);
132 * ifx_spi_power_state_clear - clear power bit
133 * @ifx_dev: our SPI device
134 * @val: bits to clear
136 * clear bit in power status and signal power system if status becomes 0
139 ifx_spi_power_state_clear(struct ifx_spi_device
*ifx_dev
, unsigned char val
)
143 spin_lock_irqsave(&ifx_dev
->power_lock
, flags
);
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
);
151 spin_unlock_irqrestore(&ifx_dev
->power_lock
, flags
);
157 * @len : number of bytes (not words) in the buffer
158 * @end: end of buffer
160 * Swap the contents of a buffer into big endian format
162 static inline void swap_buf(u16
*buf
, int len
, void *end
)
166 len
= ((len
+ 1) >> 1);
167 if ((void *)&buf
[len
] > end
) {
168 pr_err("swap_buf: swap exceeds boundary (%p > %p)!",
172 for (n
= 0; n
< len
; n
++) {
173 *buf
= cpu_to_be16(*buf
);
179 * mrdy_assert - assert MRDY line
180 * @ifx_dev: our SPI device
182 * Assert mrdy and set timer to wait for SRDY interrupt, if SRDY is low
185 * FIXME: Can SRDY even go high as we are running this code ?
187 static void mrdy_assert(struct ifx_spi_device
*ifx_dev
)
189 int val
= gpio_get_value(ifx_dev
->gpio
.srdy
);
191 if (!test_and_set_bit(IFX_SPI_STATE_TIMER_PENDING
,
193 ifx_dev
->spi_timer
.expires
=
194 jiffies
+ IFX_SPI_TIMEOUT_SEC
*HZ
;
195 add_timer(&ifx_dev
->spi_timer
);
199 ifx_spi_power_state_set(ifx_dev
, IFX_SPI_POWER_DATA_PENDING
);
200 mrdy_set_high(ifx_dev
);
204 * ifx_spi_hangup - hang up an IFX device
205 * @ifx_dev: our SPI device
207 * Hang up the tty attached to the IFX device if one is currently
208 * open. If not take no action
210 static void ifx_spi_ttyhangup(struct ifx_spi_device
*ifx_dev
)
212 struct tty_port
*pport
= &ifx_dev
->tty_port
;
213 struct tty_struct
*tty
= tty_port_tty_get(pport
);
221 * ifx_spi_timeout - SPI timeout
222 * @arg: our SPI device
224 * The SPI has timed out: hang up the tty. Users will then see a hangup
227 static void ifx_spi_timeout(unsigned long arg
)
229 struct ifx_spi_device
*ifx_dev
= (struct ifx_spi_device
*)arg
;
231 dev_warn(&ifx_dev
->spi_dev
->dev
, "*** SPI Timeout ***");
232 ifx_spi_ttyhangup(ifx_dev
);
233 mrdy_set_low(ifx_dev
);
234 clear_bit(IFX_SPI_STATE_TIMER_PENDING
, &ifx_dev
->flags
);
237 /* char/tty operations */
240 * ifx_spi_tiocmget - get modem lines
241 * @tty: our tty device
242 * @filp: file handle issuing the request
244 * Map the signal state into Linux modem flags and report the value
247 static int ifx_spi_tiocmget(struct tty_struct
*tty
, struct file
*filp
)
250 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
253 (test_bit(IFX_SPI_RTS
, &ifx_dev
->signal_state
) ? TIOCM_RTS
: 0) |
254 (test_bit(IFX_SPI_DTR
, &ifx_dev
->signal_state
) ? TIOCM_DTR
: 0) |
255 (test_bit(IFX_SPI_CTS
, &ifx_dev
->signal_state
) ? TIOCM_CTS
: 0) |
256 (test_bit(IFX_SPI_DSR
, &ifx_dev
->signal_state
) ? TIOCM_DSR
: 0) |
257 (test_bit(IFX_SPI_DCD
, &ifx_dev
->signal_state
) ? TIOCM_CAR
: 0) |
258 (test_bit(IFX_SPI_RI
, &ifx_dev
->signal_state
) ? TIOCM_RNG
: 0);
263 * ifx_spi_tiocmset - set modem bits
264 * @tty: the tty structure
265 * @filp: file handle issuing the request
267 * @clear: bits to clear
269 * The IFX6x60 only supports DTR and RTS. Set them accordingly
270 * and flag that an update to the modem is needed.
272 * FIXME: do we need to kick the tranfers when we do this ?
274 static int ifx_spi_tiocmset(struct tty_struct
*tty
, struct file
*filp
,
275 unsigned int set
, unsigned int clear
)
277 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
280 set_bit(IFX_SPI_RTS
, &ifx_dev
->signal_state
);
282 set_bit(IFX_SPI_DTR
, &ifx_dev
->signal_state
);
283 if (clear
& TIOCM_RTS
)
284 clear_bit(IFX_SPI_RTS
, &ifx_dev
->signal_state
);
285 if (clear
& TIOCM_DTR
)
286 clear_bit(IFX_SPI_DTR
, &ifx_dev
->signal_state
);
288 set_bit(IFX_SPI_UPDATE
, &ifx_dev
->signal_state
);
293 * ifx_spi_open - called on tty open
294 * @tty: our tty device
295 * @filp: file handle being associated with the tty
297 * Open the tty interface. We let the tty_port layer do all the work
300 * FIXME: Remove single device assumption and saved_ifx_dev
302 static int ifx_spi_open(struct tty_struct
*tty
, struct file
*filp
)
304 return tty_port_open(&saved_ifx_dev
->tty_port
, tty
, filp
);
308 * ifx_spi_close - called when our tty closes
309 * @tty: the tty being closed
310 * @filp: the file handle being closed
312 * Perform the close of the tty. We use the tty_port layer to do all
315 static void ifx_spi_close(struct tty_struct
*tty
, struct file
*filp
)
317 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
318 tty_port_close(&ifx_dev
->tty_port
, tty
, filp
);
319 /* FIXME: should we do an ifx_spi_reset here ? */
323 * ifx_decode_spi_header - decode received header
324 * @buffer: the received data
325 * @length: decoded length
326 * @more: decoded more flag
327 * @received_cts: status of cts we received
329 * Note how received_cts is handled -- if header is all F it is left
330 * the same as it was, if header is all 0 it is set to 0 otherwise it is
331 * taken from the incoming header.
335 static int ifx_spi_decode_spi_header(unsigned char *buffer
, int *length
,
336 unsigned char *more
, unsigned char *received_cts
)
340 u16
*in_buffer
= (u16
*)buffer
;
345 if (h1
== 0 && h2
== 0) {
347 return IFX_SPI_HEADER_0
;
348 } else if (h1
== 0xffff && h2
== 0xffff) {
349 /* spi_slave_cts remains as it was */
350 return IFX_SPI_HEADER_F
;
353 *length
= h1
& 0xfff; /* upper bits of byte are flags */
354 *more
= (buffer
[1] >> IFX_SPI_MORE_BIT
) & 1;
355 *received_cts
= (buffer
[3] >> IFX_SPI_CTS_BIT
) & 1;
360 * ifx_setup_spi_header - set header fields
361 * @txbuffer: pointer to start of SPI buffer
363 * @more: indicate if more to follow
365 * Format up an SPI header for a transfer
369 static void ifx_spi_setup_spi_header(unsigned char *txbuffer
, int tx_count
,
372 *(u16
*)(txbuffer
) = tx_count
;
373 *(u16
*)(txbuffer
+2) = IFX_SPI_PAYLOAD_SIZE
;
374 txbuffer
[1] |= (more
<< IFX_SPI_MORE_BIT
) & IFX_SPI_MORE_MASK
;
378 * ifx_spi_wakeup_serial - SPI space made
379 * @port_data: our SPI device
381 * We have emptied the FIFO enough that we want to get more data
382 * queued into it. Poke the line discipline via tty_wakeup so that
383 * it will feed us more bits
385 static void ifx_spi_wakeup_serial(struct ifx_spi_device
*ifx_dev
)
387 struct tty_struct
*tty
;
389 tty
= tty_port_tty_get(&ifx_dev
->tty_port
);
397 * ifx_spi_prepare_tx_buffer - prepare transmit frame
398 * @ifx_dev: our SPI device
400 * The transmit buffr needs a header and various other bits of
401 * information followed by as much data as we can pull from the FIFO
402 * and transfer. This function formats up a suitable buffer in the
405 * FIXME: performance - should we wake the tty when the queue is half
408 static int ifx_spi_prepare_tx_buffer(struct ifx_spi_device
*ifx_dev
)
413 unsigned char *tx_buffer
;
415 tx_buffer
= ifx_dev
->tx_buffer
;
416 memset(tx_buffer
, 0, IFX_SPI_TRANSFER_SIZE
);
418 /* make room for required SPI header */
419 tx_buffer
+= IFX_SPI_HEADER_OVERHEAD
;
420 tx_count
= IFX_SPI_HEADER_OVERHEAD
;
422 /* clear to signal no more data if this turns out to be the
423 * last buffer sent in a sequence */
424 ifx_dev
->spi_more
= 0;
426 /* if modem cts is set, just send empty buffer */
427 if (!ifx_dev
->spi_slave_cts
) {
428 /* see if there's tx data */
429 queue_length
= kfifo_len(&ifx_dev
->tx_fifo
);
430 if (queue_length
!= 0) {
431 /* data to mux -- see if there's room for it */
432 temp_count
= min(queue_length
, IFX_SPI_PAYLOAD_SIZE
);
433 temp_count
= kfifo_out_locked(&ifx_dev
->tx_fifo
,
434 tx_buffer
, temp_count
,
435 &ifx_dev
->fifo_lock
);
437 /* update buffer pointer and data count in message */
438 tx_buffer
+= temp_count
;
439 tx_count
+= temp_count
;
440 if (temp_count
== queue_length
)
441 /* poke port to get more data */
442 ifx_spi_wakeup_serial(ifx_dev
);
443 else /* more data in port, use next SPI message */
444 ifx_dev
->spi_more
= 1;
447 /* have data and info for header -- set up SPI header in buffer */
448 /* spi header needs payload size, not entire buffer size */
449 ifx_spi_setup_spi_header(ifx_dev
->tx_buffer
,
450 tx_count
-IFX_SPI_HEADER_OVERHEAD
,
452 /* swap actual data in the buffer */
453 swap_buf((u16
*)(ifx_dev
->tx_buffer
), tx_count
,
454 &ifx_dev
->tx_buffer
[IFX_SPI_TRANSFER_SIZE
]);
459 * ifx_spi_write - line discipline write
460 * @tty: our tty device
461 * @buf: pointer to buffer to write (kernel space)
462 * @count: size of buffer
464 * Write the characters we have been given into the FIFO. If the device
465 * is not active then activate it, when the SRDY line is asserted back
466 * this will commence I/O
468 static int ifx_spi_write(struct tty_struct
*tty
, const unsigned char *buf
,
471 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
472 unsigned char *tmp_buf
= (unsigned char *)buf
;
473 int tx_count
= kfifo_in_locked(&ifx_dev
->tx_fifo
, tmp_buf
, count
,
474 &ifx_dev
->fifo_lock
);
475 mrdy_assert(ifx_dev
);
480 * ifx_spi_chars_in_buffer - line discipline helper
481 * @tty: our tty device
483 * Report how much data we can accept before we drop bytes. As we use
484 * a simple FIFO this is nice and easy.
486 static int ifx_spi_write_room(struct tty_struct
*tty
)
488 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
489 return IFX_SPI_FIFO_SIZE
- kfifo_len(&ifx_dev
->tx_fifo
);
493 * ifx_spi_chars_in_buffer - line discipline helper
494 * @tty: our tty device
496 * Report how many characters we have buffered. In our case this is the
497 * number of bytes sitting in our transmit FIFO.
499 static int ifx_spi_chars_in_buffer(struct tty_struct
*tty
)
501 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
502 return kfifo_len(&ifx_dev
->tx_fifo
);
507 * @port: our tty port
509 * tty port hang up. Called when tty_hangup processing is invoked either
510 * by loss of carrier, or by software (eg vhangup). Serialized against
511 * activate/shutdown by the tty layer.
513 static void ifx_spi_hangup(struct tty_struct
*tty
)
515 struct ifx_spi_device
*ifx_dev
= tty
->driver_data
;
516 tty_port_hangup(&ifx_dev
->tty_port
);
521 * @port: our tty port
523 * tty port activate method - called for first open. Serialized
524 * with hangup and shutdown by the tty layer.
526 static int ifx_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
528 struct ifx_spi_device
*ifx_dev
=
529 container_of(port
, struct ifx_spi_device
, tty_port
);
531 /* clear any old data; can't do this in 'close' */
532 kfifo_reset(&ifx_dev
->tx_fifo
);
534 /* put port data into this tty */
535 tty
->driver_data
= ifx_dev
;
537 /* allows flip string push from int context */
538 tty
->low_latency
= 1;
545 * @port: our tty port
547 * tty port shutdown method - called for last port close. Serialized
548 * with hangup and activate by the tty layer.
550 static void ifx_port_shutdown(struct tty_port
*port
)
552 struct ifx_spi_device
*ifx_dev
=
553 container_of(port
, struct ifx_spi_device
, tty_port
);
555 mrdy_set_low(ifx_dev
);
556 clear_bit(IFX_SPI_STATE_TIMER_PENDING
, &ifx_dev
->flags
);
557 tasklet_kill(&ifx_dev
->io_work_tasklet
);
560 static const struct tty_port_operations ifx_tty_port_ops
= {
561 .activate
= ifx_port_activate
,
562 .shutdown
= ifx_port_shutdown
,
565 static const struct tty_operations ifx_spi_serial_ops
= {
566 .open
= ifx_spi_open
,
567 .close
= ifx_spi_close
,
568 .write
= ifx_spi_write
,
569 .hangup
= ifx_spi_hangup
,
570 .write_room
= ifx_spi_write_room
,
571 .chars_in_buffer
= ifx_spi_chars_in_buffer
,
572 .tiocmget
= ifx_spi_tiocmget
,
573 .tiocmset
= ifx_spi_tiocmset
,
577 * ifx_spi_insert_fip_string - queue received data
578 * @ifx_ser: our SPI device
579 * @chars: buffer we have received
580 * @size: number of chars reeived
582 * Queue bytes to the tty assuming the tty side is currently open. If
583 * not the discard the data.
585 static void ifx_spi_insert_flip_string(struct ifx_spi_device
*ifx_dev
,
586 unsigned char *chars
, size_t size
)
588 struct tty_struct
*tty
= tty_port_tty_get(&ifx_dev
->tty_port
);
591 tty_insert_flip_string(tty
, chars
, size
);
592 tty_flip_buffer_push(tty
);
597 * ifx_spi_complete - SPI transfer completed
598 * @ctx: our SPI device
600 * An SPI transfer has completed. Process any received data and kick off
601 * any further transmits we can commence.
603 static void ifx_spi_complete(void *ctx
)
605 struct ifx_spi_device
*ifx_dev
= ctx
;
606 struct tty_struct
*tty
;
607 struct tty_ldisc
*ldisc
= NULL
;
612 int local_write_pending
= 0;
617 mrdy_set_low(ifx_dev
);
619 if (!ifx_dev
->spi_msg
.status
) {
620 /* check header validity, get comm flags */
621 swap_buf((u16
*)ifx_dev
->rx_buffer
, IFX_SPI_HEADER_OVERHEAD
,
622 &ifx_dev
->rx_buffer
[IFX_SPI_HEADER_OVERHEAD
]);
623 decode_result
= ifx_spi_decode_spi_header(ifx_dev
->rx_buffer
,
624 &length
, &more
, &cts
);
625 if (decode_result
== IFX_SPI_HEADER_0
) {
626 dev_dbg(&ifx_dev
->spi_dev
->dev
,
627 "ignore input: invalid header 0");
628 ifx_dev
->spi_slave_cts
= 0;
630 } else if (decode_result
== IFX_SPI_HEADER_F
) {
631 dev_dbg(&ifx_dev
->spi_dev
->dev
,
632 "ignore input: invalid header F");
636 ifx_dev
->spi_slave_cts
= cts
;
638 actual_length
= min((unsigned int)length
,
639 ifx_dev
->spi_msg
.actual_length
);
640 swap_buf((u16
*)(ifx_dev
->rx_buffer
+ IFX_SPI_HEADER_OVERHEAD
),
642 &ifx_dev
->rx_buffer
[IFX_SPI_TRANSFER_SIZE
]);
643 ifx_spi_insert_flip_string(
645 ifx_dev
->rx_buffer
+ IFX_SPI_HEADER_OVERHEAD
,
646 (size_t)actual_length
);
648 dev_dbg(&ifx_dev
->spi_dev
->dev
, "SPI transfer error %d",
649 ifx_dev
->spi_msg
.status
);
653 if (ifx_dev
->write_pending
) {
654 ifx_dev
->write_pending
= 0;
655 local_write_pending
= 1;
658 clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS
, &(ifx_dev
->flags
));
660 queue_length
= kfifo_len(&ifx_dev
->tx_fifo
);
661 srdy
= gpio_get_value(ifx_dev
->gpio
.srdy
);
663 ifx_spi_power_state_clear(ifx_dev
, IFX_SPI_POWER_SRDY
);
665 /* schedule output if there is more to do */
666 if (test_and_clear_bit(IFX_SPI_STATE_IO_READY
, &ifx_dev
->flags
))
667 tasklet_schedule(&ifx_dev
->io_work_tasklet
);
669 if (more
|| ifx_dev
->spi_more
|| queue_length
> 0 ||
670 local_write_pending
) {
671 if (ifx_dev
->spi_slave_cts
) {
673 mrdy_assert(ifx_dev
);
675 mrdy_assert(ifx_dev
);
678 * poke line discipline driver if any for more data
679 * may or may not get more data to write
680 * for now, say not busy
682 ifx_spi_power_state_clear(ifx_dev
,
683 IFX_SPI_POWER_DATA_PENDING
);
684 tty
= tty_port_tty_get(&ifx_dev
->tty_port
);
686 ldisc
= tty_ldisc_ref(tty
);
688 ldisc
->ops
->write_wakeup(tty
);
689 tty_ldisc_deref(ldisc
);
698 * ifx_spio_io - I/O tasklet
699 * @data: our SPI device
701 * Queue data for transmission if possible and then kick off the
704 static void ifx_spi_io(unsigned long data
)
707 struct ifx_spi_device
*ifx_dev
= (struct ifx_spi_device
*) data
;
709 if (!test_and_set_bit(IFX_SPI_STATE_IO_IN_PROGRESS
, &ifx_dev
->flags
)) {
710 if (ifx_dev
->gpio
.unack_srdy_int_nb
> 0)
711 ifx_dev
->gpio
.unack_srdy_int_nb
--;
713 ifx_spi_prepare_tx_buffer(ifx_dev
);
715 spi_message_init(&ifx_dev
->spi_msg
);
716 INIT_LIST_HEAD(&ifx_dev
->spi_msg
.queue
);
718 ifx_dev
->spi_msg
.context
= ifx_dev
;
719 ifx_dev
->spi_msg
.complete
= ifx_spi_complete
;
721 /* set up our spi transfer */
722 /* note len is BYTES, not transfers */
723 ifx_dev
->spi_xfer
.len
= IFX_SPI_TRANSFER_SIZE
;
724 ifx_dev
->spi_xfer
.cs_change
= 0;
725 ifx_dev
->spi_xfer
.speed_hz
= 12500000;
726 /* ifx_dev->spi_xfer.speed_hz = 390625; */
727 ifx_dev
->spi_xfer
.bits_per_word
= spi_b16
? 16 : 8;
729 ifx_dev
->spi_xfer
.tx_buf
= ifx_dev
->tx_buffer
;
730 ifx_dev
->spi_xfer
.rx_buf
= ifx_dev
->rx_buffer
;
735 if (ifx_dev
->is_6160
) {
736 ifx_dev
->spi_msg
.is_dma_mapped
= 1;
737 ifx_dev
->tx_dma
= ifx_dev
->tx_bus
;
738 ifx_dev
->rx_dma
= ifx_dev
->rx_bus
;
739 ifx_dev
->spi_xfer
.tx_dma
= ifx_dev
->tx_dma
;
740 ifx_dev
->spi_xfer
.rx_dma
= ifx_dev
->rx_dma
;
742 ifx_dev
->spi_msg
.is_dma_mapped
= 0;
743 ifx_dev
->tx_dma
= (dma_addr_t
)0;
744 ifx_dev
->rx_dma
= (dma_addr_t
)0;
745 ifx_dev
->spi_xfer
.tx_dma
= (dma_addr_t
)0;
746 ifx_dev
->spi_xfer
.rx_dma
= (dma_addr_t
)0;
749 spi_message_add_tail(&ifx_dev
->spi_xfer
, &ifx_dev
->spi_msg
);
751 /* Assert MRDY. This may have already been done by the write
754 mrdy_assert(ifx_dev
);
756 retval
= spi_async(ifx_dev
->spi_dev
, &ifx_dev
->spi_msg
);
758 clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS
,
760 tasklet_schedule(&ifx_dev
->io_work_tasklet
);
764 ifx_dev
->write_pending
= 1;
768 * ifx_spi_free_port - free up the tty side
769 * @ifx_dev: IFX device going away
771 * Unregister and free up a port when the device goes away
773 static void ifx_spi_free_port(struct ifx_spi_device
*ifx_dev
)
775 if (ifx_dev
->tty_dev
)
776 tty_unregister_device(tty_drv
, ifx_dev
->minor
);
777 kfifo_free(&ifx_dev
->tx_fifo
);
781 * ifx_spi_create_port - create a new port
782 * @ifx_dev: our spi device
784 * Allocate and initialise the tty port that goes with this interface
785 * and add it to the tty layer so that it can be opened.
787 static int ifx_spi_create_port(struct ifx_spi_device
*ifx_dev
)
790 struct tty_port
*pport
= &ifx_dev
->tty_port
;
792 spin_lock_init(&ifx_dev
->fifo_lock
);
793 lockdep_set_class_and_subclass(&ifx_dev
->fifo_lock
,
796 if (kfifo_alloc(&ifx_dev
->tx_fifo
, IFX_SPI_FIFO_SIZE
, GFP_KERNEL
)) {
801 pport
->ops
= &ifx_tty_port_ops
;
802 tty_port_init(pport
);
803 ifx_dev
->minor
= IFX_SPI_TTY_ID
;
804 ifx_dev
->tty_dev
= tty_register_device(tty_drv
, ifx_dev
->minor
,
805 &ifx_dev
->spi_dev
->dev
);
806 if (IS_ERR(ifx_dev
->tty_dev
)) {
807 dev_dbg(&ifx_dev
->spi_dev
->dev
,
808 "%s: registering tty device failed", __func__
);
809 ret
= PTR_ERR(ifx_dev
->tty_dev
);
815 ifx_spi_free_port(ifx_dev
);
820 * ifx_spi_handle_srdy - handle SRDY
821 * @ifx_dev: device asserting SRDY
823 * Check our device state and see what we need to kick off when SRDY
824 * is asserted. This usually means killing the timer and firing off the
827 static void ifx_spi_handle_srdy(struct ifx_spi_device
*ifx_dev
)
829 if (test_bit(IFX_SPI_STATE_TIMER_PENDING
, &ifx_dev
->flags
)) {
830 del_timer_sync(&ifx_dev
->spi_timer
);
831 clear_bit(IFX_SPI_STATE_TIMER_PENDING
, &ifx_dev
->flags
);
834 ifx_spi_power_state_set(ifx_dev
, IFX_SPI_POWER_SRDY
);
836 if (!test_bit(IFX_SPI_STATE_IO_IN_PROGRESS
, &ifx_dev
->flags
))
837 tasklet_schedule(&ifx_dev
->io_work_tasklet
);
839 set_bit(IFX_SPI_STATE_IO_READY
, &ifx_dev
->flags
);
843 * ifx_spi_srdy_interrupt - SRDY asserted
844 * @irq: our IRQ number
845 * @dev: our ifx device
847 * The modem asserted SRDY. Handle the srdy event
849 static irqreturn_t
ifx_spi_srdy_interrupt(int irq
, void *dev
)
851 struct ifx_spi_device
*ifx_dev
= dev
;
852 ifx_dev
->gpio
.unack_srdy_int_nb
++;
853 ifx_spi_handle_srdy(ifx_dev
);
858 * ifx_spi_reset_interrupt - Modem has changed reset state
859 * @irq: interrupt number
860 * @dev: our device pointer
862 * The modem has either entered or left reset state. Check the GPIO
865 * FIXME: review locking on MR_INPROGRESS versus
866 * parallel unsolicited reset/solicited reset
868 static irqreturn_t
ifx_spi_reset_interrupt(int irq
, void *dev
)
870 struct ifx_spi_device
*ifx_dev
= dev
;
871 int val
= gpio_get_value(ifx_dev
->gpio
.reset_out
);
872 int solreset
= test_bit(MR_START
, &ifx_dev
->mdm_reset_state
);
876 set_bit(MR_INPROGRESS
, &ifx_dev
->mdm_reset_state
);
878 /* unsolicited reset */
879 ifx_spi_ttyhangup(ifx_dev
);
883 clear_bit(MR_INPROGRESS
, &ifx_dev
->mdm_reset_state
);
885 set_bit(MR_COMPLETE
, &ifx_dev
->mdm_reset_state
);
886 wake_up(&ifx_dev
->mdm_reset_wait
);
893 * ifx_spi_free_device - free device
894 * @ifx_dev: device to free
896 * Free the IFX device
898 static void ifx_spi_free_device(struct ifx_spi_device
*ifx_dev
)
900 ifx_spi_free_port(ifx_dev
);
901 dma_free_coherent(&ifx_dev
->spi_dev
->dev
,
902 IFX_SPI_TRANSFER_SIZE
,
905 dma_free_coherent(&ifx_dev
->spi_dev
->dev
,
906 IFX_SPI_TRANSFER_SIZE
,
912 * ifx_spi_reset - reset modem
913 * @ifx_dev: modem to reset
915 * Perform a reset on the modem
917 static int ifx_spi_reset(struct ifx_spi_device
*ifx_dev
)
921 * set up modem power, reset
923 * delays are required on some platforms for the modem
926 set_bit(MR_START
, &ifx_dev
->mdm_reset_state
);
927 gpio_set_value(ifx_dev
->gpio
.po
, 0);
928 gpio_set_value(ifx_dev
->gpio
.reset
, 0);
930 gpio_set_value(ifx_dev
->gpio
.reset
, 1);
932 gpio_set_value(ifx_dev
->gpio
.po
, 1);
934 gpio_set_value(ifx_dev
->gpio
.po
, 0);
935 ret
= wait_event_timeout(ifx_dev
->mdm_reset_wait
,
936 test_bit(MR_COMPLETE
,
937 &ifx_dev
->mdm_reset_state
),
940 dev_warn(&ifx_dev
->spi_dev
->dev
, "Modem reset timeout: (state:%lx)",
941 ifx_dev
->mdm_reset_state
);
943 ifx_dev
->mdm_reset_state
= 0;
948 * ifx_spi_spi_probe - probe callback
949 * @spi: our possible matching SPI device
951 * Probe for a 6x60 modem on SPI bus. Perform any needed device and
955 * - Support for multiple devices
956 * - Split out MID specific GPIO handling eventually
959 static int ifx_spi_spi_probe(struct spi_device
*spi
)
963 struct ifx_modem_platform_data
*pl_data
= NULL
;
964 struct ifx_spi_device
*ifx_dev
;
967 dev_dbg(&spi
->dev
, "ignoring subsequent detection");
971 /* initialize structure to hold our device variables */
972 ifx_dev
= kzalloc(sizeof(struct ifx_spi_device
), GFP_KERNEL
);
974 dev_err(&spi
->dev
, "spi device allocation failed");
977 saved_ifx_dev
= ifx_dev
;
978 ifx_dev
->spi_dev
= spi
;
979 clear_bit(IFX_SPI_STATE_IO_IN_PROGRESS
, &ifx_dev
->flags
);
980 spin_lock_init(&ifx_dev
->write_lock
);
981 spin_lock_init(&ifx_dev
->power_lock
);
982 ifx_dev
->power_status
= 0;
983 init_timer(&ifx_dev
->spi_timer
);
984 ifx_dev
->spi_timer
.function
= ifx_spi_timeout
;
985 ifx_dev
->spi_timer
.data
= (unsigned long)ifx_dev
;
986 ifx_dev
->is_6160
= pl_data
->is_6160
;
988 /* ensure SPI protocol flags are initialized to enable transfer */
989 ifx_dev
->spi_more
= 0;
990 ifx_dev
->spi_slave_cts
= 0;
992 /*initialize transfer and dma buffers */
993 ifx_dev
->tx_buffer
= dma_alloc_coherent(&ifx_dev
->spi_dev
->dev
,
994 IFX_SPI_TRANSFER_SIZE
,
997 if (!ifx_dev
->tx_buffer
) {
998 dev_err(&spi
->dev
, "DMA-TX buffer allocation failed");
1002 ifx_dev
->rx_buffer
= dma_alloc_coherent(&ifx_dev
->spi_dev
->dev
,
1003 IFX_SPI_TRANSFER_SIZE
,
1006 if (!ifx_dev
->rx_buffer
) {
1007 dev_err(&spi
->dev
, "DMA-RX buffer allocation failed");
1012 /* initialize waitq for modem reset */
1013 init_waitqueue_head(&ifx_dev
->mdm_reset_wait
);
1015 spi_set_drvdata(spi
, ifx_dev
);
1016 tasklet_init(&ifx_dev
->io_work_tasklet
, ifx_spi_io
,
1017 (unsigned long)ifx_dev
);
1019 set_bit(IFX_SPI_STATE_PRESENT
, &ifx_dev
->flags
);
1021 /* create our tty port */
1022 ret
= ifx_spi_create_port(ifx_dev
);
1024 dev_err(&spi
->dev
, "create default tty port failed");
1028 pl_data
= (struct ifx_modem_platform_data
*)spi
->dev
.platform_data
;
1030 ifx_dev
->gpio
.reset
= pl_data
->rst_pmu
;
1031 ifx_dev
->gpio
.po
= pl_data
->pwr_on
;
1032 ifx_dev
->gpio
.mrdy
= pl_data
->mrdy
;
1033 ifx_dev
->gpio
.srdy
= pl_data
->srdy
;
1034 ifx_dev
->gpio
.reset_out
= pl_data
->rst_out
;
1036 dev_err(&spi
->dev
, "missing platform data!");
1041 dev_info(&spi
->dev
, "gpios %d, %d, %d, %d, %d",
1042 ifx_dev
->gpio
.reset
, ifx_dev
->gpio
.po
, ifx_dev
->gpio
.mrdy
,
1043 ifx_dev
->gpio
.srdy
, ifx_dev
->gpio
.reset_out
);
1045 /* Configure gpios */
1046 ret
= gpio_request(ifx_dev
->gpio
.reset
, "ifxModem");
1048 dev_err(&spi
->dev
, "Unable to allocate GPIO%d (RESET)",
1049 ifx_dev
->gpio
.reset
);
1052 ret
+= gpio_direction_output(ifx_dev
->gpio
.reset
, 0);
1053 ret
+= gpio_export(ifx_dev
->gpio
.reset
, 1);
1055 dev_err(&spi
->dev
, "Unable to configure GPIO%d (RESET)",
1056 ifx_dev
->gpio
.reset
);
1061 ret
= gpio_request(ifx_dev
->gpio
.po
, "ifxModem");
1062 ret
+= gpio_direction_output(ifx_dev
->gpio
.po
, 0);
1063 ret
+= gpio_export(ifx_dev
->gpio
.po
, 1);
1065 dev_err(&spi
->dev
, "Unable to configure GPIO%d (ON)",
1071 ret
= gpio_request(ifx_dev
->gpio
.mrdy
, "ifxModem");
1073 dev_err(&spi
->dev
, "Unable to allocate GPIO%d (MRDY)",
1074 ifx_dev
->gpio
.mrdy
);
1077 ret
+= gpio_export(ifx_dev
->gpio
.mrdy
, 1);
1078 ret
+= gpio_direction_output(ifx_dev
->gpio
.mrdy
, 0);
1080 dev_err(&spi
->dev
, "Unable to configure GPIO%d (MRDY)",
1081 ifx_dev
->gpio
.mrdy
);
1086 ret
= gpio_request(ifx_dev
->gpio
.srdy
, "ifxModem");
1088 dev_err(&spi
->dev
, "Unable to allocate GPIO%d (SRDY)",
1089 ifx_dev
->gpio
.srdy
);
1093 ret
+= gpio_export(ifx_dev
->gpio
.srdy
, 1);
1094 ret
+= gpio_direction_input(ifx_dev
->gpio
.srdy
);
1096 dev_err(&spi
->dev
, "Unable to configure GPIO%d (SRDY)",
1097 ifx_dev
->gpio
.srdy
);
1102 ret
= gpio_request(ifx_dev
->gpio
.reset_out
, "ifxModem");
1104 dev_err(&spi
->dev
, "Unable to allocate GPIO%d (RESET_OUT)",
1105 ifx_dev
->gpio
.reset_out
);
1108 ret
+= gpio_export(ifx_dev
->gpio
.reset_out
, 1);
1109 ret
+= gpio_direction_input(ifx_dev
->gpio
.reset_out
);
1111 dev_err(&spi
->dev
, "Unable to configure GPIO%d (RESET_OUT)",
1112 ifx_dev
->gpio
.reset_out
);
1117 ret
= request_irq(gpio_to_irq(ifx_dev
->gpio
.reset_out
),
1118 ifx_spi_reset_interrupt
,
1119 IRQF_TRIGGER_RISING
|IRQF_TRIGGER_FALLING
, DRVNAME
,
1122 dev_err(&spi
->dev
, "Unable to get irq %x\n",
1123 gpio_to_irq(ifx_dev
->gpio
.reset_out
));
1127 ret
= ifx_spi_reset(ifx_dev
);
1129 ret
= request_irq(gpio_to_irq(ifx_dev
->gpio
.srdy
),
1130 ifx_spi_srdy_interrupt
,
1131 IRQF_TRIGGER_RISING
, DRVNAME
,
1134 dev_err(&spi
->dev
, "Unable to get irq %x",
1135 gpio_to_irq(ifx_dev
->gpio
.srdy
));
1139 /* set pm runtime power state and register with power system */
1140 pm_runtime_set_active(&spi
->dev
);
1141 pm_runtime_enable(&spi
->dev
);
1143 /* handle case that modem is already signaling SRDY */
1144 /* no outgoing tty open at this point, this just satisfies the
1145 * modem's read and should reset communication properly
1147 srdy
= gpio_get_value(ifx_dev
->gpio
.srdy
);
1150 mrdy_assert(ifx_dev
);
1151 ifx_spi_handle_srdy(ifx_dev
);
1153 mrdy_set_low(ifx_dev
);
1157 gpio_free(ifx_dev
->gpio
.srdy
);
1159 gpio_free(ifx_dev
->gpio
.mrdy
);
1161 gpio_free(ifx_dev
->gpio
.reset
);
1163 gpio_free(ifx_dev
->gpio
.po
);
1165 gpio_free(ifx_dev
->gpio
.reset_out
);
1167 ifx_spi_free_device(ifx_dev
);
1168 saved_ifx_dev
= NULL
;
1173 * ifx_spi_spi_remove - SPI device was removed
1176 * FIXME: We should be shutting the device down here not in
1177 * the module unload path.
1180 static int ifx_spi_spi_remove(struct spi_device
*spi
)
1182 struct ifx_spi_device
*ifx_dev
= spi_get_drvdata(spi
);
1184 tasklet_kill(&ifx_dev
->io_work_tasklet
);
1186 free_irq(gpio_to_irq(ifx_dev
->gpio
.reset_out
), (void *)ifx_dev
);
1187 free_irq(gpio_to_irq(ifx_dev
->gpio
.srdy
), (void *)ifx_dev
);
1189 gpio_free(ifx_dev
->gpio
.srdy
);
1190 gpio_free(ifx_dev
->gpio
.mrdy
);
1191 gpio_free(ifx_dev
->gpio
.reset
);
1192 gpio_free(ifx_dev
->gpio
.po
);
1193 gpio_free(ifx_dev
->gpio
.reset_out
);
1195 /* free allocations */
1196 ifx_spi_free_device(ifx_dev
);
1198 saved_ifx_dev
= NULL
;
1203 * ifx_spi_spi_shutdown - called on SPI shutdown
1206 * No action needs to be taken here
1209 static void ifx_spi_spi_shutdown(struct spi_device
*spi
)
1214 * various suspends and resumes have nothing to do
1215 * no hardware to save state for
1219 * ifx_spi_spi_suspend - suspend SPI on system suspend
1220 * @dev: device being suspended
1222 * Suspend the SPI side. No action needed on Intel MID platforms, may
1223 * need extending for other systems.
1225 static int ifx_spi_spi_suspend(struct spi_device
*spi
, pm_message_t msg
)
1231 * ifx_spi_spi_resume - resume SPI side on system resume
1232 * @dev: device being suspended
1234 * Suspend the SPI side. No action needed on Intel MID platforms, may
1235 * need extending for other systems.
1237 static int ifx_spi_spi_resume(struct spi_device
*spi
)
1243 * ifx_spi_pm_suspend - suspend modem on system suspend
1244 * @dev: device being suspended
1246 * Suspend the modem. No action needed on Intel MID platforms, may
1247 * need extending for other systems.
1249 static int ifx_spi_pm_suspend(struct device
*dev
)
1255 * ifx_spi_pm_resume - resume modem on system resume
1256 * @dev: device being suspended
1258 * Allow the modem to resume. No action needed.
1260 * FIXME: do we need to reset anything here ?
1262 static int ifx_spi_pm_resume(struct device
*dev
)
1268 * ifx_spi_pm_runtime_resume - suspend modem
1269 * @dev: device being suspended
1271 * Allow the modem to resume. No action needed.
1273 static int ifx_spi_pm_runtime_resume(struct device
*dev
)
1279 * ifx_spi_pm_runtime_suspend - suspend modem
1280 * @dev: device being suspended
1282 * Allow the modem to suspend and thus suspend to continue up the
1285 static int ifx_spi_pm_runtime_suspend(struct device
*dev
)
1291 * ifx_spi_pm_runtime_idle - check if modem idle
1294 * Check conditions and queue runtime suspend if idle.
1296 static int ifx_spi_pm_runtime_idle(struct device
*dev
)
1298 struct spi_device
*spi
= to_spi_device(dev
);
1299 struct ifx_spi_device
*ifx_dev
= spi_get_drvdata(spi
);
1301 if (!ifx_dev
->power_status
)
1302 pm_runtime_suspend(dev
);
1307 static const struct dev_pm_ops ifx_spi_pm
= {
1308 .resume
= ifx_spi_pm_resume
,
1309 .suspend
= ifx_spi_pm_suspend
,
1310 .runtime_resume
= ifx_spi_pm_runtime_resume
,
1311 .runtime_suspend
= ifx_spi_pm_runtime_suspend
,
1312 .runtime_idle
= ifx_spi_pm_runtime_idle
1315 static const struct spi_device_id ifx_id_table
[] = {
1320 MODULE_DEVICE_TABLE(spi
, ifx_id_table
);
1322 /* spi operations */
1323 static const struct spi_driver ifx_spi_driver_6160
= {
1326 .bus
= &spi_bus_type
,
1328 .owner
= THIS_MODULE
},
1329 .probe
= ifx_spi_spi_probe
,
1330 .shutdown
= ifx_spi_spi_shutdown
,
1331 .remove
= __devexit_p(ifx_spi_spi_remove
),
1332 .suspend
= ifx_spi_spi_suspend
,
1333 .resume
= ifx_spi_spi_resume
,
1334 .id_table
= ifx_id_table
1338 * ifx_spi_exit - module exit
1340 * Unload the module.
1343 static void __exit
ifx_spi_exit(void)
1346 tty_unregister_driver(tty_drv
);
1347 spi_unregister_driver((void *)&ifx_spi_driver_6160
);
1351 * ifx_spi_init - module entry point
1353 * Initialise the SPI and tty interfaces for the IFX SPI driver
1354 * We need to initialize upper-edge spi driver after the tty
1355 * driver because otherwise the spi probe will race
1358 static int __init
ifx_spi_init(void)
1362 tty_drv
= alloc_tty_driver(1);
1364 pr_err("%s: alloc_tty_driver failed", DRVNAME
);
1368 tty_drv
->magic
= TTY_DRIVER_MAGIC
;
1369 tty_drv
->owner
= THIS_MODULE
;
1370 tty_drv
->driver_name
= DRVNAME
;
1371 tty_drv
->name
= TTYNAME
;
1372 tty_drv
->minor_start
= IFX_SPI_TTY_ID
;
1374 tty_drv
->type
= TTY_DRIVER_TYPE_SERIAL
;
1375 tty_drv
->subtype
= SERIAL_TYPE_NORMAL
;
1376 tty_drv
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
1377 tty_drv
->init_termios
= tty_std_termios
;
1379 tty_set_operations(tty_drv
, &ifx_spi_serial_ops
);
1381 result
= tty_register_driver(tty_drv
);
1383 pr_err("%s: tty_register_driver failed(%d)",
1388 result
= spi_register_driver((void *)&ifx_spi_driver_6160
);
1390 pr_err("%s: spi_register_driver failed(%d)",
1392 tty_unregister_driver(tty_drv
);
1397 module_init(ifx_spi_init
);
1398 module_exit(ifx_spi_exit
);
1400 MODULE_AUTHOR("Intel");
1401 MODULE_DESCRIPTION("IFX6x60 spi driver");
1402 MODULE_LICENSE("GPL");
1403 MODULE_INFO(Version
, "0.1-IFX6x60");