xref: /linux/drivers/misc/ibmasm/ibmasm.h (revision f3d9478b2ce468c3115b02ecae7e975990697f15)
1 
2 /*
3  * IBM ASM Service Processor Device Driver
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  *
19  * Copyright (C) IBM Corporation, 2004
20  *
21  * Author: Max Asb�ck <amax@us.ibm.com>
22  *
23  */
24 
25 #include <linux/kernel.h>
26 #include <linux/types.h>
27 #include <linux/errno.h>
28 #include <linux/list.h>
29 #include <linux/wait.h>
30 #include <linux/spinlock.h>
31 #include <linux/slab.h>
32 #include <linux/config.h>
33 #include <linux/module.h>
34 #include <linux/interrupt.h>
35 #include <linux/device.h>
36 #include <linux/input.h>
37 
38 /* Driver identification */
39 #define DRIVER_NAME	"ibmasm"
40 #define DRIVER_VERSION  "1.0"
41 #define DRIVER_AUTHOR   "Max Asbock <masbock@us.ibm.com>, Vernon Mauery <vernux@us.ibm.com>"
42 #define DRIVER_DESC     "IBM ASM Service Processor Driver"
43 
44 #define err(msg) printk(KERN_ERR "%s: " msg "\n", DRIVER_NAME)
45 #define info(msg) printk(KERN_INFO "%s: " msg "\n", DRIVER_NAME)
46 
47 extern int ibmasm_debug;
48 #define dbg(STR, ARGS...)					\
49 	do {							\
50 		if (ibmasm_debug)				\
51 			printk(KERN_DEBUG STR , ##ARGS);	\
52 	} while (0)
53 
54 static inline char *get_timestamp(char *buf)
55 {
56 	struct timeval now;
57 	do_gettimeofday(&now);
58 	sprintf(buf, "%lu.%lu", now.tv_sec, now.tv_usec);
59 	return buf;
60 }
61 
62 #define IBMASM_CMD_PENDING	0
63 #define IBMASM_CMD_COMPLETE	1
64 #define IBMASM_CMD_FAILED	2
65 
66 #define IBMASM_CMD_TIMEOUT_NORMAL	45
67 #define IBMASM_CMD_TIMEOUT_EXTRA	240
68 
69 #define IBMASM_CMD_MAX_BUFFER_SIZE	0x8000
70 
71 #define REVERSE_HEARTBEAT_TIMEOUT	120
72 
73 #define HEARTBEAT_BUFFER_SIZE		0x400
74 
75 #ifdef IA64
76 #define IBMASM_DRIVER_VPD "Lin64 6.08      "
77 #else
78 #define IBMASM_DRIVER_VPD "Lin32 6.08      "
79 #endif
80 
81 #define SYSTEM_STATE_OS_UP      5
82 #define SYSTEM_STATE_OS_DOWN    4
83 
84 #define IBMASM_NAME_SIZE	16
85 
86 #define IBMASM_NUM_EVENTS	10
87 #define IBMASM_EVENT_MAX_SIZE	2048u
88 
89 
90 struct command {
91 	struct list_head	queue_node;
92 	wait_queue_head_t	wait;
93 	unsigned char		*buffer;
94 	size_t			buffer_size;
95 	int			status;
96 	struct kobject		kobj;
97 	spinlock_t		*lock;
98 };
99 #define to_command(c) container_of(c, struct command, kobj)
100 
101 static inline void command_put(struct command *cmd)
102 {
103 	unsigned long flags;
104 	spinlock_t *lock = cmd->lock;
105 
106 	spin_lock_irqsave(lock, flags);
107 	kobject_put(&cmd->kobj);
108 	spin_unlock_irqrestore(lock, flags);
109 }
110 
111 static inline void command_get(struct command *cmd)
112 {
113 	kobject_get(&cmd->kobj);
114 }
115 
116 
117 struct ibmasm_event {
118 	unsigned int	serial_number;
119 	unsigned int	data_size;
120 	unsigned char	data[IBMASM_EVENT_MAX_SIZE];
121 };
122 
123 struct event_buffer {
124 	struct ibmasm_event	events[IBMASM_NUM_EVENTS];
125 	unsigned int		next_serial_number;
126 	unsigned int		next_index;
127 	struct list_head	readers;
128 };
129 
130 struct event_reader {
131 	int			cancelled;
132 	unsigned int		next_serial_number;
133 	wait_queue_head_t	wait;
134 	struct list_head	node;
135 	unsigned int		data_size;
136 	unsigned char		data[IBMASM_EVENT_MAX_SIZE];
137 };
138 
139 struct reverse_heartbeat {
140 	wait_queue_head_t	wait;
141 	unsigned int		stopped;
142 };
143 
144 struct ibmasm_remote {
145 	struct input_dev *keybd_dev;
146 	struct input_dev *mouse_dev;
147 };
148 
149 struct service_processor {
150 	struct list_head	node;
151 	spinlock_t		lock;
152 	void __iomem		*base_address;
153 	unsigned int		irq;
154 	struct command		*current_command;
155 	struct command		*heartbeat;
156 	struct list_head	command_queue;
157 	struct event_buffer	*event_buffer;
158 	char			dirname[IBMASM_NAME_SIZE];
159 	char			devname[IBMASM_NAME_SIZE];
160 	unsigned int		number;
161 	struct ibmasm_remote	remote;
162 	int			serial_line;
163 	struct device		*dev;
164 };
165 
166 /* command processing */
167 extern struct command *ibmasm_new_command(struct service_processor *sp, size_t buffer_size);
168 extern void ibmasm_exec_command(struct service_processor *sp, struct command *cmd);
169 extern void ibmasm_wait_for_response(struct command *cmd, int timeout);
170 extern void ibmasm_receive_command_response(struct service_processor *sp, void *response,  size_t size);
171 
172 /* event processing */
173 extern int ibmasm_event_buffer_init(struct service_processor *sp);
174 extern void ibmasm_event_buffer_exit(struct service_processor *sp);
175 extern void ibmasm_receive_event(struct service_processor *sp, void *data,  unsigned int data_size);
176 extern void ibmasm_event_reader_register(struct service_processor *sp, struct event_reader *reader);
177 extern void ibmasm_event_reader_unregister(struct service_processor *sp, struct event_reader *reader);
178 extern int ibmasm_get_next_event(struct service_processor *sp, struct event_reader *reader);
179 extern void ibmasm_cancel_next_event(struct event_reader *reader);
180 
181 /* heartbeat - from SP to OS */
182 extern void ibmasm_register_panic_notifier(void);
183 extern void ibmasm_unregister_panic_notifier(void);
184 extern int ibmasm_heartbeat_init(struct service_processor *sp);
185 extern void ibmasm_heartbeat_exit(struct service_processor *sp);
186 extern void ibmasm_receive_heartbeat(struct service_processor *sp,  void *message, size_t size);
187 
188 /* reverse heartbeat - from OS to SP */
189 extern void ibmasm_init_reverse_heartbeat(struct service_processor *sp, struct reverse_heartbeat *rhb);
190 extern int ibmasm_start_reverse_heartbeat(struct service_processor *sp, struct reverse_heartbeat *rhb);
191 extern void ibmasm_stop_reverse_heartbeat(struct reverse_heartbeat *rhb);
192 
193 /* dot commands */
194 extern void ibmasm_receive_message(struct service_processor *sp, void *data, int data_size);
195 extern int ibmasm_send_driver_vpd(struct service_processor *sp);
196 extern int ibmasm_send_os_state(struct service_processor *sp, int os_state);
197 
198 /* low level message processing */
199 extern int ibmasm_send_i2o_message(struct service_processor *sp);
200 extern irqreturn_t ibmasm_interrupt_handler(int irq, void * dev_id, struct pt_regs *regs);
201 
202 /* remote console */
203 extern void ibmasm_handle_mouse_interrupt(struct service_processor *sp, struct pt_regs *regs);
204 extern int ibmasm_init_remote_input_dev(struct service_processor *sp);
205 extern void ibmasm_free_remote_input_dev(struct service_processor *sp);
206 
207 /* file system */
208 extern int ibmasmfs_register(void);
209 extern void ibmasmfs_unregister(void);
210 extern void ibmasmfs_add_sp(struct service_processor *sp);
211 
212 /* uart */
213 #ifdef CONFIG_SERIAL_8250
214 extern void ibmasm_register_uart(struct service_processor *sp);
215 extern void ibmasm_unregister_uart(struct service_processor *sp);
216 #else
217 #define ibmasm_register_uart(sp)	do { } while(0)
218 #define ibmasm_unregister_uart(sp)	do { } while(0)
219 #endif
220