au1550_spi: fix prototype of irq handler
[wrt350n-kernel.git] / drivers / ps3 / ps3-vuart.c
blob90c097a7a47ab5fc7a41b298f3beb968dbadd359
1 /*
2 * PS3 virtual uart
4 * Copyright (C) 2006 Sony Computer Entertainment Inc.
5 * Copyright 2006 Sony Corp.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/interrupt.h>
24 #include <linux/workqueue.h>
25 #include <linux/bitops.h>
26 #include <asm/ps3.h>
28 #include <asm/firmware.h>
29 #include <asm/lv1call.h>
31 #include "vuart.h"
33 MODULE_AUTHOR("Sony Corporation");
34 MODULE_LICENSE("GPL v2");
35 MODULE_DESCRIPTION("PS3 vuart");
37 /**
38 * vuart - An inter-partition data link service.
39 * port 0: PS3 AV Settings.
40 * port 2: PS3 System Manager.
42 * The vuart provides a bi-directional byte stream data link between logical
43 * partitions. Its primary role is as a communications link between the guest
44 * OS and the system policy module. The current HV does not support any
45 * connections other than those listed.
48 enum {PORT_COUNT = 3,};
50 enum vuart_param {
51 PARAM_TX_TRIGGER = 0,
52 PARAM_RX_TRIGGER = 1,
53 PARAM_INTERRUPT_MASK = 2,
54 PARAM_RX_BUF_SIZE = 3, /* read only */
55 PARAM_RX_BYTES = 4, /* read only */
56 PARAM_TX_BUF_SIZE = 5, /* read only */
57 PARAM_TX_BYTES = 6, /* read only */
58 PARAM_INTERRUPT_STATUS = 7, /* read only */
61 enum vuart_interrupt_bit {
62 INTERRUPT_BIT_TX = 0,
63 INTERRUPT_BIT_RX = 1,
64 INTERRUPT_BIT_DISCONNECT = 2,
67 enum vuart_interrupt_mask {
68 INTERRUPT_MASK_TX = 1,
69 INTERRUPT_MASK_RX = 2,
70 INTERRUPT_MASK_DISCONNECT = 4,
73 /**
74 * struct ps3_vuart_port_priv - private vuart device data.
77 struct ps3_vuart_port_priv {
78 u64 interrupt_mask;
80 struct {
81 spinlock_t lock;
82 struct list_head head;
83 } tx_list;
84 struct {
85 struct ps3_vuart_work work;
86 unsigned long bytes_held;
87 spinlock_t lock;
88 struct list_head head;
89 } rx_list;
90 struct ps3_vuart_stats stats;
93 static struct ps3_vuart_port_priv *to_port_priv(
94 struct ps3_system_bus_device *dev)
96 BUG_ON(!dev);
97 BUG_ON(!dev->driver_priv);
98 return (struct ps3_vuart_port_priv *)dev->driver_priv;
102 * struct ports_bmp - bitmap indicating ports needing service.
104 * A 256 bit read only bitmap indicating ports needing service. Do not write
105 * to these bits. Must not cross a page boundary.
108 struct ports_bmp {
109 u64 status;
110 u64 unused[3];
111 } __attribute__((aligned(32)));
113 #define dump_ports_bmp(_b) _dump_ports_bmp(_b, __func__, __LINE__)
114 static void __maybe_unused _dump_ports_bmp(
115 const struct ports_bmp *bmp, const char *func, int line)
117 pr_debug("%s:%d: ports_bmp: %016lxh\n", func, line, bmp->status);
120 #define dump_port_params(_b) _dump_port_params(_b, __func__, __LINE__)
121 static void __maybe_unused _dump_port_params(unsigned int port_number,
122 const char *func, int line)
124 #if defined(DEBUG)
125 static const char *strings[] = {
126 "tx_trigger ",
127 "rx_trigger ",
128 "interrupt_mask ",
129 "rx_buf_size ",
130 "rx_bytes ",
131 "tx_buf_size ",
132 "tx_bytes ",
133 "interrupt_status",
135 int result;
136 unsigned int i;
137 u64 value;
139 for (i = 0; i < ARRAY_SIZE(strings); i++) {
140 result = lv1_get_virtual_uart_param(port_number, i, &value);
142 if (result) {
143 pr_debug("%s:%d: port_%u: %s failed: %s\n", func, line,
144 port_number, strings[i], ps3_result(result));
145 continue;
147 pr_debug("%s:%d: port_%u: %s = %lxh\n",
148 func, line, port_number, strings[i], value);
150 #endif
153 struct vuart_triggers {
154 unsigned long rx;
155 unsigned long tx;
158 int ps3_vuart_get_triggers(struct ps3_system_bus_device *dev,
159 struct vuart_triggers *trig)
161 int result;
162 unsigned long size;
163 unsigned long val;
165 result = lv1_get_virtual_uart_param(dev->port_number,
166 PARAM_TX_TRIGGER, &trig->tx);
168 if (result) {
169 dev_dbg(&dev->core, "%s:%d: tx_trigger failed: %s\n",
170 __func__, __LINE__, ps3_result(result));
171 return result;
174 result = lv1_get_virtual_uart_param(dev->port_number,
175 PARAM_RX_BUF_SIZE, &size);
177 if (result) {
178 dev_dbg(&dev->core, "%s:%d: tx_buf_size failed: %s\n",
179 __func__, __LINE__, ps3_result(result));
180 return result;
183 result = lv1_get_virtual_uart_param(dev->port_number,
184 PARAM_RX_TRIGGER, &val);
186 if (result) {
187 dev_dbg(&dev->core, "%s:%d: rx_trigger failed: %s\n",
188 __func__, __LINE__, ps3_result(result));
189 return result;
192 trig->rx = size - val;
194 dev_dbg(&dev->core, "%s:%d: tx %lxh, rx %lxh\n", __func__, __LINE__,
195 trig->tx, trig->rx);
197 return result;
200 int ps3_vuart_set_triggers(struct ps3_system_bus_device *dev, unsigned int tx,
201 unsigned int rx)
203 int result;
204 unsigned long size;
206 result = lv1_set_virtual_uart_param(dev->port_number,
207 PARAM_TX_TRIGGER, tx);
209 if (result) {
210 dev_dbg(&dev->core, "%s:%d: tx_trigger failed: %s\n",
211 __func__, __LINE__, ps3_result(result));
212 return result;
215 result = lv1_get_virtual_uart_param(dev->port_number,
216 PARAM_RX_BUF_SIZE, &size);
218 if (result) {
219 dev_dbg(&dev->core, "%s:%d: tx_buf_size failed: %s\n",
220 __func__, __LINE__, ps3_result(result));
221 return result;
224 result = lv1_set_virtual_uart_param(dev->port_number,
225 PARAM_RX_TRIGGER, size - rx);
227 if (result) {
228 dev_dbg(&dev->core, "%s:%d: rx_trigger failed: %s\n",
229 __func__, __LINE__, ps3_result(result));
230 return result;
233 dev_dbg(&dev->core, "%s:%d: tx %xh, rx %xh\n", __func__, __LINE__,
234 tx, rx);
236 return result;
239 static int ps3_vuart_get_rx_bytes_waiting(struct ps3_system_bus_device *dev,
240 u64 *bytes_waiting)
242 int result;
244 result = lv1_get_virtual_uart_param(dev->port_number,
245 PARAM_RX_BYTES, bytes_waiting);
247 if (result)
248 dev_dbg(&dev->core, "%s:%d: rx_bytes failed: %s\n",
249 __func__, __LINE__, ps3_result(result));
251 dev_dbg(&dev->core, "%s:%d: %lxh\n", __func__, __LINE__,
252 *bytes_waiting);
253 return result;
257 * ps3_vuart_set_interrupt_mask - Enable/disable the port interrupt sources.
258 * @dev: The struct ps3_system_bus_device instance.
259 * @bmp: Logical OR of enum vuart_interrupt_mask values. A zero bit disables.
262 static int ps3_vuart_set_interrupt_mask(struct ps3_system_bus_device *dev,
263 unsigned long mask)
265 int result;
266 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
268 dev_dbg(&dev->core, "%s:%d: %lxh\n", __func__, __LINE__, mask);
270 priv->interrupt_mask = mask;
272 result = lv1_set_virtual_uart_param(dev->port_number,
273 PARAM_INTERRUPT_MASK, priv->interrupt_mask);
275 if (result)
276 dev_dbg(&dev->core, "%s:%d: interrupt_mask failed: %s\n",
277 __func__, __LINE__, ps3_result(result));
279 return result;
282 static int ps3_vuart_get_interrupt_status(struct ps3_system_bus_device *dev,
283 unsigned long *status)
285 int result;
286 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
287 u64 tmp;
289 result = lv1_get_virtual_uart_param(dev->port_number,
290 PARAM_INTERRUPT_STATUS, &tmp);
292 if (result)
293 dev_dbg(&dev->core, "%s:%d: interrupt_status failed: %s\n",
294 __func__, __LINE__, ps3_result(result));
296 *status = tmp & priv->interrupt_mask;
298 dev_dbg(&dev->core, "%s:%d: m %lxh, s %lxh, m&s %lxh\n",
299 __func__, __LINE__, priv->interrupt_mask, tmp, *status);
301 return result;
304 int ps3_vuart_enable_interrupt_tx(struct ps3_system_bus_device *dev)
306 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
308 return (priv->interrupt_mask & INTERRUPT_MASK_TX) ? 0
309 : ps3_vuart_set_interrupt_mask(dev, priv->interrupt_mask
310 | INTERRUPT_MASK_TX);
313 int ps3_vuart_enable_interrupt_rx(struct ps3_system_bus_device *dev)
315 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
317 return (priv->interrupt_mask & INTERRUPT_MASK_RX) ? 0
318 : ps3_vuart_set_interrupt_mask(dev, priv->interrupt_mask
319 | INTERRUPT_MASK_RX);
322 int ps3_vuart_enable_interrupt_disconnect(struct ps3_system_bus_device *dev)
324 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
326 return (priv->interrupt_mask & INTERRUPT_MASK_DISCONNECT) ? 0
327 : ps3_vuart_set_interrupt_mask(dev, priv->interrupt_mask
328 | INTERRUPT_MASK_DISCONNECT);
331 int ps3_vuart_disable_interrupt_tx(struct ps3_system_bus_device *dev)
333 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
335 return (priv->interrupt_mask & INTERRUPT_MASK_TX)
336 ? ps3_vuart_set_interrupt_mask(dev, priv->interrupt_mask
337 & ~INTERRUPT_MASK_TX) : 0;
340 int ps3_vuart_disable_interrupt_rx(struct ps3_system_bus_device *dev)
342 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
344 return (priv->interrupt_mask & INTERRUPT_MASK_RX)
345 ? ps3_vuart_set_interrupt_mask(dev, priv->interrupt_mask
346 & ~INTERRUPT_MASK_RX) : 0;
349 int ps3_vuart_disable_interrupt_disconnect(struct ps3_system_bus_device *dev)
351 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
353 return (priv->interrupt_mask & INTERRUPT_MASK_DISCONNECT)
354 ? ps3_vuart_set_interrupt_mask(dev, priv->interrupt_mask
355 & ~INTERRUPT_MASK_DISCONNECT) : 0;
359 * ps3_vuart_raw_write - Low level write helper.
360 * @dev: The struct ps3_system_bus_device instance.
362 * Do not call ps3_vuart_raw_write directly, use ps3_vuart_write.
365 static int ps3_vuart_raw_write(struct ps3_system_bus_device *dev,
366 const void *buf, unsigned int bytes, unsigned long *bytes_written)
368 int result;
369 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
371 result = lv1_write_virtual_uart(dev->port_number,
372 ps3_mm_phys_to_lpar(__pa(buf)), bytes, bytes_written);
374 if (result) {
375 dev_dbg(&dev->core, "%s:%d: lv1_write_virtual_uart failed: "
376 "%s\n", __func__, __LINE__, ps3_result(result));
377 return result;
380 priv->stats.bytes_written += *bytes_written;
382 dev_dbg(&dev->core, "%s:%d: wrote %lxh/%xh=>%lxh\n", __func__, __LINE__,
383 *bytes_written, bytes, priv->stats.bytes_written);
385 return result;
389 * ps3_vuart_raw_read - Low level read helper.
390 * @dev: The struct ps3_system_bus_device instance.
392 * Do not call ps3_vuart_raw_read directly, use ps3_vuart_read.
395 static int ps3_vuart_raw_read(struct ps3_system_bus_device *dev, void *buf,
396 unsigned int bytes, unsigned long *bytes_read)
398 int result;
399 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
401 dev_dbg(&dev->core, "%s:%d: %xh\n", __func__, __LINE__, bytes);
403 result = lv1_read_virtual_uart(dev->port_number,
404 ps3_mm_phys_to_lpar(__pa(buf)), bytes, bytes_read);
406 if (result) {
407 dev_dbg(&dev->core, "%s:%d: lv1_read_virtual_uart failed: %s\n",
408 __func__, __LINE__, ps3_result(result));
409 return result;
412 priv->stats.bytes_read += *bytes_read;
414 dev_dbg(&dev->core, "%s:%d: read %lxh/%xh=>%lxh\n", __func__, __LINE__,
415 *bytes_read, bytes, priv->stats.bytes_read);
417 return result;
421 * ps3_vuart_clear_rx_bytes - Discard bytes received.
422 * @dev: The struct ps3_system_bus_device instance.
423 * @bytes: Max byte count to discard, zero = all pending.
425 * Used to clear pending rx interrupt source. Will not block.
428 void ps3_vuart_clear_rx_bytes(struct ps3_system_bus_device *dev,
429 unsigned int bytes)
431 int result;
432 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
433 u64 bytes_waiting;
434 void *tmp;
436 result = ps3_vuart_get_rx_bytes_waiting(dev, &bytes_waiting);
438 BUG_ON(result);
440 bytes = bytes ? min(bytes, (unsigned int)bytes_waiting) : bytes_waiting;
442 dev_dbg(&dev->core, "%s:%d: %u\n", __func__, __LINE__, bytes);
444 if (!bytes)
445 return;
447 /* Add some extra space for recently arrived data. */
449 bytes += 128;
451 tmp = kmalloc(bytes, GFP_KERNEL);
453 if (!tmp)
454 return;
456 ps3_vuart_raw_read(dev, tmp, bytes, &bytes_waiting);
458 kfree(tmp);
460 /* Don't include these bytes in the stats. */
462 priv->stats.bytes_read -= bytes_waiting;
464 EXPORT_SYMBOL_GPL(ps3_vuart_clear_rx_bytes);
467 * struct list_buffer - An element for a port device fifo buffer list.
470 struct list_buffer {
471 struct list_head link;
472 const unsigned char *head;
473 const unsigned char *tail;
474 unsigned long dbg_number;
475 unsigned char data[];
479 * ps3_vuart_write - the entry point for writing data to a port
480 * @dev: The struct ps3_system_bus_device instance.
482 * If the port is idle on entry as much of the incoming data is written to
483 * the port as the port will accept. Otherwise a list buffer is created
484 * and any remaning incoming data is copied to that buffer. The buffer is
485 * then enqueued for transmision via the transmit interrupt.
488 int ps3_vuart_write(struct ps3_system_bus_device *dev, const void *buf,
489 unsigned int bytes)
491 static unsigned long dbg_number;
492 int result;
493 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
494 unsigned long flags;
495 struct list_buffer *lb;
497 dev_dbg(&dev->core, "%s:%d: %u(%xh) bytes\n", __func__, __LINE__,
498 bytes, bytes);
500 spin_lock_irqsave(&priv->tx_list.lock, flags);
502 if (list_empty(&priv->tx_list.head)) {
503 unsigned long bytes_written;
505 result = ps3_vuart_raw_write(dev, buf, bytes, &bytes_written);
507 spin_unlock_irqrestore(&priv->tx_list.lock, flags);
509 if (result) {
510 dev_dbg(&dev->core,
511 "%s:%d: ps3_vuart_raw_write failed\n",
512 __func__, __LINE__);
513 return result;
516 if (bytes_written == bytes) {
517 dev_dbg(&dev->core, "%s:%d: wrote %xh bytes\n",
518 __func__, __LINE__, bytes);
519 return 0;
522 bytes -= bytes_written;
523 buf += bytes_written;
524 } else
525 spin_unlock_irqrestore(&priv->tx_list.lock, flags);
527 lb = kmalloc(sizeof(struct list_buffer) + bytes, GFP_KERNEL);
529 if (!lb)
530 return -ENOMEM;
532 memcpy(lb->data, buf, bytes);
533 lb->head = lb->data;
534 lb->tail = lb->data + bytes;
535 lb->dbg_number = ++dbg_number;
537 spin_lock_irqsave(&priv->tx_list.lock, flags);
538 list_add_tail(&lb->link, &priv->tx_list.head);
539 ps3_vuart_enable_interrupt_tx(dev);
540 spin_unlock_irqrestore(&priv->tx_list.lock, flags);
542 dev_dbg(&dev->core, "%s:%d: queued buf_%lu, %xh bytes\n",
543 __func__, __LINE__, lb->dbg_number, bytes);
545 return 0;
547 EXPORT_SYMBOL_GPL(ps3_vuart_write);
550 * ps3_vuart_queue_rx_bytes - Queue waiting bytes into the buffer list.
551 * @dev: The struct ps3_system_bus_device instance.
552 * @bytes_queued: Number of bytes queued to the buffer list.
554 * Must be called with priv->rx_list.lock held.
557 static int ps3_vuart_queue_rx_bytes(struct ps3_system_bus_device *dev,
558 u64 *bytes_queued)
560 static unsigned long dbg_number;
561 int result;
562 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
563 struct list_buffer *lb;
564 u64 bytes;
566 *bytes_queued = 0;
568 result = ps3_vuart_get_rx_bytes_waiting(dev, &bytes);
569 BUG_ON(result);
571 if (result)
572 return -EIO;
574 if (!bytes)
575 return 0;
577 /* Add some extra space for recently arrived data. */
579 bytes += 128;
581 lb = kmalloc(sizeof(struct list_buffer) + bytes, GFP_ATOMIC);
583 if (!lb)
584 return -ENOMEM;
586 ps3_vuart_raw_read(dev, lb->data, bytes, &bytes);
588 lb->head = lb->data;
589 lb->tail = lb->data + bytes;
590 lb->dbg_number = ++dbg_number;
592 list_add_tail(&lb->link, &priv->rx_list.head);
593 priv->rx_list.bytes_held += bytes;
595 dev_dbg(&dev->core, "%s:%d: buf_%lu: queued %lxh bytes\n",
596 __func__, __LINE__, lb->dbg_number, bytes);
598 *bytes_queued = bytes;
600 return 0;
604 * ps3_vuart_read - The entry point for reading data from a port.
606 * Queue data waiting at the port, and if enough bytes to satisfy the request
607 * are held in the buffer list those bytes are dequeued and copied to the
608 * caller's buffer. Emptied list buffers are retiered. If the request cannot
609 * be statified by bytes held in the list buffers -EAGAIN is returned.
612 int ps3_vuart_read(struct ps3_system_bus_device *dev, void *buf,
613 unsigned int bytes)
615 int result;
616 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
617 unsigned long flags;
618 struct list_buffer *lb, *n;
619 unsigned long bytes_read;
621 dev_dbg(&dev->core, "%s:%d: %u(%xh) bytes\n", __func__, __LINE__,
622 bytes, bytes);
624 spin_lock_irqsave(&priv->rx_list.lock, flags);
626 /* Queue rx bytes here for polled reads. */
628 while (priv->rx_list.bytes_held < bytes) {
629 u64 tmp;
631 result = ps3_vuart_queue_rx_bytes(dev, &tmp);
632 if (result || !tmp) {
633 dev_dbg(&dev->core, "%s:%d: starved for %lxh bytes\n",
634 __func__, __LINE__,
635 bytes - priv->rx_list.bytes_held);
636 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
637 return -EAGAIN;
641 list_for_each_entry_safe(lb, n, &priv->rx_list.head, link) {
642 bytes_read = min((unsigned int)(lb->tail - lb->head), bytes);
644 memcpy(buf, lb->head, bytes_read);
645 buf += bytes_read;
646 bytes -= bytes_read;
647 priv->rx_list.bytes_held -= bytes_read;
649 if (bytes_read < lb->tail - lb->head) {
650 lb->head += bytes_read;
651 dev_dbg(&dev->core, "%s:%d: buf_%lu: dequeued %lxh "
652 "bytes\n", __func__, __LINE__, lb->dbg_number,
653 bytes_read);
654 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
655 return 0;
658 dev_dbg(&dev->core, "%s:%d: buf_%lu: free, dequeued %lxh "
659 "bytes\n", __func__, __LINE__, lb->dbg_number,
660 bytes_read);
662 list_del(&lb->link);
663 kfree(lb);
666 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
667 return 0;
669 EXPORT_SYMBOL_GPL(ps3_vuart_read);
672 * ps3_vuart_work - Asynchronous read handler.
675 static void ps3_vuart_work(struct work_struct *work)
677 struct ps3_system_bus_device *dev =
678 ps3_vuart_work_to_system_bus_dev(work);
679 struct ps3_vuart_port_driver *drv =
680 ps3_system_bus_dev_to_vuart_drv(dev);
682 BUG_ON(!drv);
683 drv->work(dev);
686 int ps3_vuart_read_async(struct ps3_system_bus_device *dev, unsigned int bytes)
688 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
689 unsigned long flags;
691 if (priv->rx_list.work.trigger) {
692 dev_dbg(&dev->core, "%s:%d: warning, multiple calls\n",
693 __func__, __LINE__);
694 return -EAGAIN;
697 BUG_ON(!bytes);
699 PREPARE_WORK(&priv->rx_list.work.work, ps3_vuart_work);
701 spin_lock_irqsave(&priv->rx_list.lock, flags);
702 if (priv->rx_list.bytes_held >= bytes) {
703 dev_dbg(&dev->core, "%s:%d: schedule_work %xh bytes\n",
704 __func__, __LINE__, bytes);
705 schedule_work(&priv->rx_list.work.work);
706 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
707 return 0;
710 priv->rx_list.work.trigger = bytes;
711 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
713 dev_dbg(&dev->core, "%s:%d: waiting for %u(%xh) bytes\n", __func__,
714 __LINE__, bytes, bytes);
716 return 0;
718 EXPORT_SYMBOL_GPL(ps3_vuart_read_async);
720 void ps3_vuart_cancel_async(struct ps3_system_bus_device *dev)
722 to_port_priv(dev)->rx_list.work.trigger = 0;
724 EXPORT_SYMBOL_GPL(ps3_vuart_cancel_async);
727 * ps3_vuart_handle_interrupt_tx - third stage transmit interrupt handler
729 * Services the transmit interrupt for the port. Writes as much data from the
730 * buffer list as the port will accept. Retires any emptied list buffers and
731 * adjusts the final list buffer state for a partial write.
734 static int ps3_vuart_handle_interrupt_tx(struct ps3_system_bus_device *dev)
736 int result = 0;
737 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
738 unsigned long flags;
739 struct list_buffer *lb, *n;
740 unsigned long bytes_total = 0;
742 dev_dbg(&dev->core, "%s:%d\n", __func__, __LINE__);
744 spin_lock_irqsave(&priv->tx_list.lock, flags);
746 list_for_each_entry_safe(lb, n, &priv->tx_list.head, link) {
748 unsigned long bytes_written;
750 result = ps3_vuart_raw_write(dev, lb->head, lb->tail - lb->head,
751 &bytes_written);
753 if (result) {
754 dev_dbg(&dev->core,
755 "%s:%d: ps3_vuart_raw_write failed\n",
756 __func__, __LINE__);
757 break;
760 bytes_total += bytes_written;
762 if (bytes_written < lb->tail - lb->head) {
763 lb->head += bytes_written;
764 dev_dbg(&dev->core,
765 "%s:%d cleared buf_%lu, %lxh bytes\n",
766 __func__, __LINE__, lb->dbg_number,
767 bytes_written);
768 goto port_full;
771 dev_dbg(&dev->core, "%s:%d free buf_%lu\n", __func__, __LINE__,
772 lb->dbg_number);
774 list_del(&lb->link);
775 kfree(lb);
778 ps3_vuart_disable_interrupt_tx(dev);
779 port_full:
780 spin_unlock_irqrestore(&priv->tx_list.lock, flags);
781 dev_dbg(&dev->core, "%s:%d wrote %lxh bytes total\n",
782 __func__, __LINE__, bytes_total);
783 return result;
787 * ps3_vuart_handle_interrupt_rx - third stage receive interrupt handler
789 * Services the receive interrupt for the port. Creates a list buffer and
790 * copies all waiting port data to that buffer and enqueues the buffer in the
791 * buffer list. Buffer list data is dequeued via ps3_vuart_read.
794 static int ps3_vuart_handle_interrupt_rx(struct ps3_system_bus_device *dev)
796 int result;
797 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
798 unsigned long flags;
799 u64 bytes;
801 dev_dbg(&dev->core, "%s:%d\n", __func__, __LINE__);
803 spin_lock_irqsave(&priv->rx_list.lock, flags);
804 result = ps3_vuart_queue_rx_bytes(dev, &bytes);
806 if (result) {
807 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
808 return result;
811 if (priv->rx_list.work.trigger && priv->rx_list.bytes_held
812 >= priv->rx_list.work.trigger) {
813 dev_dbg(&dev->core, "%s:%d: schedule_work %lxh bytes\n",
814 __func__, __LINE__, priv->rx_list.work.trigger);
815 priv->rx_list.work.trigger = 0;
816 schedule_work(&priv->rx_list.work.work);
819 spin_unlock_irqrestore(&priv->rx_list.lock, flags);
820 return result;
823 static int ps3_vuart_handle_interrupt_disconnect(
824 struct ps3_system_bus_device *dev)
826 dev_dbg(&dev->core, "%s:%d\n", __func__, __LINE__);
827 BUG_ON("no support");
828 return -1;
832 * ps3_vuart_handle_port_interrupt - second stage interrupt handler
834 * Services any pending interrupt types for the port. Passes control to the
835 * third stage type specific interrupt handler. Returns control to the first
836 * stage handler after one iteration.
839 static int ps3_vuart_handle_port_interrupt(struct ps3_system_bus_device *dev)
841 int result;
842 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
843 unsigned long status;
845 result = ps3_vuart_get_interrupt_status(dev, &status);
847 if (result)
848 return result;
850 dev_dbg(&dev->core, "%s:%d: status: %lxh\n", __func__, __LINE__,
851 status);
853 if (status & INTERRUPT_MASK_DISCONNECT) {
854 priv->stats.disconnect_interrupts++;
855 result = ps3_vuart_handle_interrupt_disconnect(dev);
856 if (result)
857 ps3_vuart_disable_interrupt_disconnect(dev);
860 if (status & INTERRUPT_MASK_TX) {
861 priv->stats.tx_interrupts++;
862 result = ps3_vuart_handle_interrupt_tx(dev);
863 if (result)
864 ps3_vuart_disable_interrupt_tx(dev);
867 if (status & INTERRUPT_MASK_RX) {
868 priv->stats.rx_interrupts++;
869 result = ps3_vuart_handle_interrupt_rx(dev);
870 if (result)
871 ps3_vuart_disable_interrupt_rx(dev);
874 return 0;
877 struct vuart_bus_priv {
878 struct ports_bmp *bmp;
879 unsigned int virq;
880 struct mutex probe_mutex;
881 int use_count;
882 struct ps3_system_bus_device *devices[PORT_COUNT];
883 } static vuart_bus_priv;
886 * ps3_vuart_irq_handler - first stage interrupt handler
888 * Loops finding any interrupting port and its associated instance data.
889 * Passes control to the second stage port specific interrupt handler. Loops
890 * until all outstanding interrupts are serviced.
893 static irqreturn_t ps3_vuart_irq_handler(int irq, void *_private)
895 struct vuart_bus_priv *bus_priv = _private;
897 BUG_ON(!bus_priv);
899 while (1) {
900 unsigned int port;
902 dump_ports_bmp(bus_priv->bmp);
904 port = (BITS_PER_LONG - 1) - __ilog2(bus_priv->bmp->status);
906 if (port == BITS_PER_LONG)
907 break;
909 BUG_ON(port >= PORT_COUNT);
910 BUG_ON(!bus_priv->devices[port]);
912 ps3_vuart_handle_port_interrupt(bus_priv->devices[port]);
915 return IRQ_HANDLED;
918 static int ps3_vuart_bus_interrupt_get(void)
920 int result;
922 pr_debug(" -> %s:%d\n", __func__, __LINE__);
924 vuart_bus_priv.use_count++;
926 BUG_ON(vuart_bus_priv.use_count > 2);
928 if (vuart_bus_priv.use_count != 1)
929 return 0;
931 BUG_ON(vuart_bus_priv.bmp);
933 vuart_bus_priv.bmp = kzalloc(sizeof(struct ports_bmp), GFP_KERNEL);
935 if (!vuart_bus_priv.bmp) {
936 pr_debug("%s:%d: kzalloc failed.\n", __func__, __LINE__);
937 result = -ENOMEM;
938 goto fail_bmp_malloc;
941 result = ps3_vuart_irq_setup(PS3_BINDING_CPU_ANY, vuart_bus_priv.bmp,
942 &vuart_bus_priv.virq);
944 if (result) {
945 pr_debug("%s:%d: ps3_vuart_irq_setup failed (%d)\n",
946 __func__, __LINE__, result);
947 result = -EPERM;
948 goto fail_alloc_irq;
951 result = request_irq(vuart_bus_priv.virq, ps3_vuart_irq_handler,
952 IRQF_DISABLED, "vuart", &vuart_bus_priv);
954 if (result) {
955 pr_debug("%s:%d: request_irq failed (%d)\n",
956 __func__, __LINE__, result);
957 goto fail_request_irq;
960 pr_debug(" <- %s:%d: ok\n", __func__, __LINE__);
961 return result;
963 fail_request_irq:
964 ps3_vuart_irq_destroy(vuart_bus_priv.virq);
965 vuart_bus_priv.virq = NO_IRQ;
966 fail_alloc_irq:
967 kfree(vuart_bus_priv.bmp);
968 vuart_bus_priv.bmp = NULL;
969 fail_bmp_malloc:
970 vuart_bus_priv.use_count--;
971 pr_debug(" <- %s:%d: failed\n", __func__, __LINE__);
972 return result;
975 static int ps3_vuart_bus_interrupt_put(void)
977 pr_debug(" -> %s:%d\n", __func__, __LINE__);
979 vuart_bus_priv.use_count--;
981 BUG_ON(vuart_bus_priv.use_count < 0);
983 if (vuart_bus_priv.use_count != 0)
984 return 0;
986 free_irq(vuart_bus_priv.virq, &vuart_bus_priv);
988 ps3_vuart_irq_destroy(vuart_bus_priv.virq);
989 vuart_bus_priv.virq = NO_IRQ;
991 kfree(vuart_bus_priv.bmp);
992 vuart_bus_priv.bmp = NULL;
994 pr_debug(" <- %s:%d\n", __func__, __LINE__);
995 return 0;
998 static int ps3_vuart_probe(struct ps3_system_bus_device *dev)
1000 int result;
1001 struct ps3_vuart_port_driver *drv;
1002 struct ps3_vuart_port_priv *priv = NULL;
1004 dev_dbg(&dev->core, "%s:%d\n", __func__, __LINE__);
1006 drv = ps3_system_bus_dev_to_vuart_drv(dev);
1008 dev_dbg(&dev->core, "%s:%d: (%s)\n", __func__, __LINE__,
1009 drv->core.core.name);
1011 BUG_ON(!drv);
1013 if (dev->port_number >= PORT_COUNT) {
1014 BUG();
1015 return -EINVAL;
1018 mutex_lock(&vuart_bus_priv.probe_mutex);
1020 result = ps3_vuart_bus_interrupt_get();
1022 if (result)
1023 goto fail_setup_interrupt;
1025 if (vuart_bus_priv.devices[dev->port_number]) {
1026 dev_dbg(&dev->core, "%s:%d: port busy (%d)\n", __func__,
1027 __LINE__, dev->port_number);
1028 result = -EBUSY;
1029 goto fail_busy;
1032 vuart_bus_priv.devices[dev->port_number] = dev;
1034 /* Setup dev->driver_priv. */
1036 dev->driver_priv = kzalloc(sizeof(struct ps3_vuart_port_priv),
1037 GFP_KERNEL);
1039 if (!dev->driver_priv) {
1040 result = -ENOMEM;
1041 goto fail_dev_malloc;
1044 priv = to_port_priv(dev);
1046 INIT_LIST_HEAD(&priv->tx_list.head);
1047 spin_lock_init(&priv->tx_list.lock);
1049 INIT_LIST_HEAD(&priv->rx_list.head);
1050 spin_lock_init(&priv->rx_list.lock);
1052 INIT_WORK(&priv->rx_list.work.work, NULL);
1053 priv->rx_list.work.trigger = 0;
1054 priv->rx_list.work.dev = dev;
1056 /* clear stale pending interrupts */
1058 ps3_vuart_clear_rx_bytes(dev, 0);
1060 ps3_vuart_set_interrupt_mask(dev, INTERRUPT_MASK_RX);
1062 ps3_vuart_set_triggers(dev, 1, 1);
1064 if (drv->probe)
1065 result = drv->probe(dev);
1066 else {
1067 result = 0;
1068 dev_info(&dev->core, "%s:%d: no probe method\n", __func__,
1069 __LINE__);
1072 if (result) {
1073 dev_dbg(&dev->core, "%s:%d: drv->probe failed\n",
1074 __func__, __LINE__);
1075 goto fail_probe;
1078 mutex_unlock(&vuart_bus_priv.probe_mutex);
1080 return result;
1082 fail_probe:
1083 ps3_vuart_set_interrupt_mask(dev, 0);
1084 kfree(dev->driver_priv);
1085 dev->driver_priv = NULL;
1086 fail_dev_malloc:
1087 vuart_bus_priv.devices[dev->port_number] = NULL;
1088 fail_busy:
1089 ps3_vuart_bus_interrupt_put();
1090 fail_setup_interrupt:
1091 mutex_unlock(&vuart_bus_priv.probe_mutex);
1092 dev_dbg(&dev->core, "%s:%d: failed\n", __func__, __LINE__);
1093 return result;
1097 * ps3_vuart_cleanup - common cleanup helper.
1098 * @dev: The struct ps3_system_bus_device instance.
1100 * Cleans interrupts and HV resources. Must be called with
1101 * vuart_bus_priv.probe_mutex held. Used by ps3_vuart_remove and
1102 * ps3_vuart_shutdown. After this call, polled reading will still work.
1105 static int ps3_vuart_cleanup(struct ps3_system_bus_device *dev)
1107 dev_dbg(&dev->core, "%s:%d\n", __func__, __LINE__);
1109 ps3_vuart_cancel_async(dev);
1110 ps3_vuart_set_interrupt_mask(dev, 0);
1111 ps3_vuart_bus_interrupt_put();
1112 return 0;
1116 * ps3_vuart_remove - Completely clean the device instance.
1117 * @dev: The struct ps3_system_bus_device instance.
1119 * Cleans all memory, interrupts and HV resources. After this call the
1120 * device can no longer be used.
1123 static int ps3_vuart_remove(struct ps3_system_bus_device *dev)
1125 struct ps3_vuart_port_priv *priv = to_port_priv(dev);
1126 struct ps3_vuart_port_driver *drv;
1128 BUG_ON(!dev);
1130 mutex_lock(&vuart_bus_priv.probe_mutex);
1132 dev_dbg(&dev->core, " -> %s:%d: match_id %d\n", __func__, __LINE__,
1133 dev->match_id);
1135 if (!dev->core.driver) {
1136 dev_dbg(&dev->core, "%s:%d: no driver bound\n", __func__,
1137 __LINE__);
1138 mutex_unlock(&vuart_bus_priv.probe_mutex);
1139 return 0;
1142 drv = ps3_system_bus_dev_to_vuart_drv(dev);
1144 BUG_ON(!drv);
1146 if (drv->remove) {
1147 drv->remove(dev);
1148 } else {
1149 dev_dbg(&dev->core, "%s:%d: no remove method\n", __func__,
1150 __LINE__);
1151 BUG();
1154 ps3_vuart_cleanup(dev);
1156 vuart_bus_priv.devices[dev->port_number] = NULL;
1157 kfree(priv);
1158 priv = NULL;
1160 dev_dbg(&dev->core, " <- %s:%d\n", __func__, __LINE__);
1161 mutex_unlock(&vuart_bus_priv.probe_mutex);
1162 return 0;
1166 * ps3_vuart_shutdown - Cleans interrupts and HV resources.
1167 * @dev: The struct ps3_system_bus_device instance.
1169 * Cleans interrupts and HV resources. After this call the
1170 * device can still be used in polling mode. This behavior required
1171 * by sys-manager to be able to complete the device power operation
1172 * sequence.
1175 static int ps3_vuart_shutdown(struct ps3_system_bus_device *dev)
1177 struct ps3_vuart_port_driver *drv;
1179 BUG_ON(!dev);
1181 mutex_lock(&vuart_bus_priv.probe_mutex);
1183 dev_dbg(&dev->core, " -> %s:%d: match_id %d\n", __func__, __LINE__,
1184 dev->match_id);
1186 if (!dev->core.driver) {
1187 dev_dbg(&dev->core, "%s:%d: no driver bound\n", __func__,
1188 __LINE__);
1189 mutex_unlock(&vuart_bus_priv.probe_mutex);
1190 return 0;
1193 drv = ps3_system_bus_dev_to_vuart_drv(dev);
1195 BUG_ON(!drv);
1197 if (drv->shutdown)
1198 drv->shutdown(dev);
1199 else if (drv->remove) {
1200 dev_dbg(&dev->core, "%s:%d: no shutdown, calling remove\n",
1201 __func__, __LINE__);
1202 drv->remove(dev);
1203 } else {
1204 dev_dbg(&dev->core, "%s:%d: no shutdown method\n", __func__,
1205 __LINE__);
1206 BUG();
1209 ps3_vuart_cleanup(dev);
1211 dev_dbg(&dev->core, " <- %s:%d\n", __func__, __LINE__);
1213 mutex_unlock(&vuart_bus_priv.probe_mutex);
1214 return 0;
1217 static int __init ps3_vuart_bus_init(void)
1219 pr_debug("%s:%d:\n", __func__, __LINE__);
1221 if (!firmware_has_feature(FW_FEATURE_PS3_LV1))
1222 return -ENODEV;
1224 mutex_init(&vuart_bus_priv.probe_mutex);
1226 return 0;
1229 static void __exit ps3_vuart_bus_exit(void)
1231 pr_debug("%s:%d:\n", __func__, __LINE__);
1234 core_initcall(ps3_vuart_bus_init);
1235 module_exit(ps3_vuart_bus_exit);
1238 * ps3_vuart_port_driver_register - Add a vuart port device driver.
1241 int ps3_vuart_port_driver_register(struct ps3_vuart_port_driver *drv)
1243 int result;
1245 pr_debug("%s:%d: (%s)\n", __func__, __LINE__, drv->core.core.name);
1247 BUG_ON(!drv->core.match_id);
1248 BUG_ON(!drv->core.core.name);
1250 drv->core.probe = ps3_vuart_probe;
1251 drv->core.remove = ps3_vuart_remove;
1252 drv->core.shutdown = ps3_vuart_shutdown;
1254 result = ps3_system_bus_driver_register(&drv->core);
1255 return result;
1257 EXPORT_SYMBOL_GPL(ps3_vuart_port_driver_register);
1260 * ps3_vuart_port_driver_unregister - Remove a vuart port device driver.
1263 void ps3_vuart_port_driver_unregister(struct ps3_vuart_port_driver *drv)
1265 pr_debug("%s:%d: (%s)\n", __func__, __LINE__, drv->core.core.name);
1266 ps3_system_bus_driver_unregister(&drv->core);
1268 EXPORT_SYMBOL_GPL(ps3_vuart_port_driver_unregister);