ibmasm.h revision 736ce43295682d060f2b93624b4a339f9af6aab1
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 47extern int ibmasm_debug; 48#define dbg(STR, ARGS...) \ 49 do { \ 50 if (ibmasm_debug) \ 51 printk(KERN_DEBUG STR , ##ARGS); \ 52 } while (0) 53 54static 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 90struct 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 101static inline void command_put(struct command *cmd) 102{ 103 unsigned long flags; 104 105 spin_lock_irqsave(cmd->lock, flags); 106 kobject_put(&cmd->kobj); 107 spin_unlock_irqrestore(cmd->lock, flags); 108} 109 110static inline void command_get(struct command *cmd) 111{ 112 kobject_get(&cmd->kobj); 113} 114 115 116struct ibmasm_event { 117 unsigned int serial_number; 118 unsigned int data_size; 119 unsigned char data[IBMASM_EVENT_MAX_SIZE]; 120}; 121 122struct event_buffer { 123 struct ibmasm_event events[IBMASM_NUM_EVENTS]; 124 unsigned int next_serial_number; 125 unsigned int next_index; 126 struct list_head readers; 127}; 128 129struct event_reader { 130 int cancelled; 131 unsigned int next_serial_number; 132 wait_queue_head_t wait; 133 struct list_head node; 134 unsigned int data_size; 135 unsigned char data[IBMASM_EVENT_MAX_SIZE]; 136}; 137 138struct reverse_heartbeat { 139 wait_queue_head_t wait; 140 unsigned int stopped; 141}; 142 143struct ibmasm_remote { 144 struct input_dev *keybd_dev; 145 struct input_dev *mouse_dev; 146}; 147 148struct service_processor { 149 struct list_head node; 150 spinlock_t lock; 151 void __iomem *base_address; 152 unsigned int irq; 153 struct command *current_command; 154 struct command *heartbeat; 155 struct list_head command_queue; 156 struct event_buffer *event_buffer; 157 char dirname[IBMASM_NAME_SIZE]; 158 char devname[IBMASM_NAME_SIZE]; 159 unsigned int number; 160 struct ibmasm_remote remote; 161 int serial_line; 162 struct device *dev; 163}; 164 165/* command processing */ 166extern struct command *ibmasm_new_command(struct service_processor *sp, size_t buffer_size); 167extern void ibmasm_exec_command(struct service_processor *sp, struct command *cmd); 168extern void ibmasm_wait_for_response(struct command *cmd, int timeout); 169extern void ibmasm_receive_command_response(struct service_processor *sp, void *response, size_t size); 170 171/* event processing */ 172extern int ibmasm_event_buffer_init(struct service_processor *sp); 173extern void ibmasm_event_buffer_exit(struct service_processor *sp); 174extern void ibmasm_receive_event(struct service_processor *sp, void *data, unsigned int data_size); 175extern void ibmasm_event_reader_register(struct service_processor *sp, struct event_reader *reader); 176extern void ibmasm_event_reader_unregister(struct service_processor *sp, struct event_reader *reader); 177extern int ibmasm_get_next_event(struct service_processor *sp, struct event_reader *reader); 178extern void ibmasm_cancel_next_event(struct event_reader *reader); 179 180/* heartbeat - from SP to OS */ 181extern void ibmasm_register_panic_notifier(void); 182extern void ibmasm_unregister_panic_notifier(void); 183extern int ibmasm_heartbeat_init(struct service_processor *sp); 184extern void ibmasm_heartbeat_exit(struct service_processor *sp); 185extern void ibmasm_receive_heartbeat(struct service_processor *sp, void *message, size_t size); 186 187/* reverse heartbeat - from OS to SP */ 188extern void ibmasm_init_reverse_heartbeat(struct service_processor *sp, struct reverse_heartbeat *rhb); 189extern int ibmasm_start_reverse_heartbeat(struct service_processor *sp, struct reverse_heartbeat *rhb); 190extern void ibmasm_stop_reverse_heartbeat(struct reverse_heartbeat *rhb); 191 192/* dot commands */ 193extern void ibmasm_receive_message(struct service_processor *sp, void *data, int data_size); 194extern int ibmasm_send_driver_vpd(struct service_processor *sp); 195extern int ibmasm_send_os_state(struct service_processor *sp, int os_state); 196 197/* low level message processing */ 198extern int ibmasm_send_i2o_message(struct service_processor *sp); 199extern irqreturn_t ibmasm_interrupt_handler(int irq, void * dev_id, struct pt_regs *regs); 200 201/* remote console */ 202extern void ibmasm_handle_mouse_interrupt(struct service_processor *sp, struct pt_regs *regs); 203extern int ibmasm_init_remote_input_dev(struct service_processor *sp); 204extern void ibmasm_free_remote_input_dev(struct service_processor *sp); 205 206/* file system */ 207extern int ibmasmfs_register(void); 208extern void ibmasmfs_unregister(void); 209extern void ibmasmfs_add_sp(struct service_processor *sp); 210 211/* uart */ 212#ifdef CONFIG_SERIAL_8250 213extern void ibmasm_register_uart(struct service_processor *sp); 214extern void ibmasm_unregister_uart(struct service_processor *sp); 215#else 216#define ibmasm_register_uart(sp) do { } while(0) 217#define ibmasm_unregister_uart(sp) do { } while(0) 218#endif 219