xref: /openbmc/linux/drivers/ps3/vuart.h (revision 75c86e7422751c5be3caaf448d802839ec685725)
174e95d5dSGeoff Levand /*
274e95d5dSGeoff Levand  *  PS3 virtual uart
374e95d5dSGeoff Levand  *
474e95d5dSGeoff Levand  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
574e95d5dSGeoff Levand  *  Copyright 2006 Sony Corp.
674e95d5dSGeoff Levand  *
774e95d5dSGeoff Levand  *  This program is free software; you can redistribute it and/or modify
874e95d5dSGeoff Levand  *  it under the terms of the GNU General Public License as published by
974e95d5dSGeoff Levand  *  the Free Software Foundation; version 2 of the License.
1074e95d5dSGeoff Levand  *
1174e95d5dSGeoff Levand  *  This program is distributed in the hope that it will be useful,
1274e95d5dSGeoff Levand  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
1374e95d5dSGeoff Levand  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1474e95d5dSGeoff Levand  *  GNU General Public License for more details.
1574e95d5dSGeoff Levand  *
1674e95d5dSGeoff Levand  *  You should have received a copy of the GNU General Public License
1774e95d5dSGeoff Levand  *  along with this program; if not, write to the Free Software
1874e95d5dSGeoff Levand  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
1974e95d5dSGeoff Levand  */
2074e95d5dSGeoff Levand 
2174e95d5dSGeoff Levand #if !defined(_PS3_VUART_H)
2274e95d5dSGeoff Levand #define _PS3_VUART_H
2374e95d5dSGeoff Levand 
24*75c86e74SGeoff Levand #include <asm/ps3.h>
25*75c86e74SGeoff Levand 
26*75c86e74SGeoff Levand struct ps3_vuart_stats {
27*75c86e74SGeoff Levand 	unsigned long bytes_written;
28*75c86e74SGeoff Levand 	unsigned long bytes_read;
29*75c86e74SGeoff Levand 	unsigned long tx_interrupts;
30*75c86e74SGeoff Levand 	unsigned long rx_interrupts;
31*75c86e74SGeoff Levand 	unsigned long disconnect_interrupts;
32*75c86e74SGeoff Levand };
33*75c86e74SGeoff Levand 
34*75c86e74SGeoff Levand /**
35*75c86e74SGeoff Levand  * struct ps3_vuart_port_priv - private vuart device data.
36*75c86e74SGeoff Levand  */
37*75c86e74SGeoff Levand 
38*75c86e74SGeoff Levand struct ps3_vuart_port_priv {
39*75c86e74SGeoff Levand 	unsigned int port_number;
40*75c86e74SGeoff Levand 	u64 interrupt_mask;
41*75c86e74SGeoff Levand 
42*75c86e74SGeoff Levand 	struct {
43*75c86e74SGeoff Levand 		spinlock_t lock;
44*75c86e74SGeoff Levand 		struct list_head head;
45*75c86e74SGeoff Levand 	} tx_list;
46*75c86e74SGeoff Levand 	struct {
47*75c86e74SGeoff Levand 		unsigned long bytes_held;
48*75c86e74SGeoff Levand 		spinlock_t lock;
49*75c86e74SGeoff Levand 		struct list_head head;
50*75c86e74SGeoff Levand 	} rx_list;
51*75c86e74SGeoff Levand 	struct ps3_vuart_stats stats;
52*75c86e74SGeoff Levand };
53*75c86e74SGeoff Levand 
5474e95d5dSGeoff Levand /**
5574e95d5dSGeoff Levand  * struct ps3_vuart_port_driver - a driver for a device on a vuart port
5674e95d5dSGeoff Levand  */
5774e95d5dSGeoff Levand 
5874e95d5dSGeoff Levand struct ps3_vuart_port_driver {
5974e95d5dSGeoff Levand 	enum ps3_match_id match_id;
6074e95d5dSGeoff Levand 	struct device_driver core;
6174e95d5dSGeoff Levand 	int (*probe)(struct ps3_vuart_port_device *);
6274e95d5dSGeoff Levand 	int (*remove)(struct ps3_vuart_port_device *);
635b8e8ee6SGeert Uytterhoeven 	void (*shutdown)(struct ps3_vuart_port_device *);
6474e95d5dSGeoff Levand 	int (*tx_event)(struct ps3_vuart_port_device *dev);
6574e95d5dSGeoff Levand 	int (*rx_event)(struct ps3_vuart_port_device *dev);
6674e95d5dSGeoff Levand 	int (*disconnect_event)(struct ps3_vuart_port_device *dev);
6774e95d5dSGeoff Levand 	/* int (*suspend)(struct ps3_vuart_port_device *, pm_message_t); */
6874e95d5dSGeoff Levand 	/* int (*resume)(struct ps3_vuart_port_device *); */
6974e95d5dSGeoff Levand };
7074e95d5dSGeoff Levand 
7174e95d5dSGeoff Levand int ps3_vuart_port_driver_register(struct ps3_vuart_port_driver *drv);
7274e95d5dSGeoff Levand void ps3_vuart_port_driver_unregister(struct ps3_vuart_port_driver *drv);
7397ec1675SGeoff Levand 
7474e95d5dSGeoff Levand int ps3_vuart_write(struct ps3_vuart_port_device *dev,
7574e95d5dSGeoff Levand 	const void* buf, unsigned int bytes);
7674e95d5dSGeoff Levand int ps3_vuart_read(struct ps3_vuart_port_device *dev, void* buf,
7774e95d5dSGeoff Levand 	unsigned int bytes);
7874e95d5dSGeoff Levand static inline struct ps3_vuart_port_driver *to_ps3_vuart_port_driver(
7974e95d5dSGeoff Levand 	struct device_driver *_drv)
8074e95d5dSGeoff Levand {
8174e95d5dSGeoff Levand 	return container_of(_drv, struct ps3_vuart_port_driver, core);
8274e95d5dSGeoff Levand }
8374e95d5dSGeoff Levand static inline struct ps3_vuart_port_device *to_ps3_vuart_port_device(
8474e95d5dSGeoff Levand 	struct device *_dev)
8574e95d5dSGeoff Levand {
8674e95d5dSGeoff Levand 	return container_of(_dev, struct ps3_vuart_port_device, core);
8774e95d5dSGeoff Levand }
8874e95d5dSGeoff Levand 
8974e95d5dSGeoff Levand #endif
90