ibmasm.h revision 8818760512424f60ad9fafb7a087b007a9274eb3
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/version.h> 35#include <linux/interrupt.h> 36#include <linux/device.h> 37#include <linux/input.h> 38 39/* Driver identification */ 40#define DRIVER_NAME "ibmasm" 41#define DRIVER_VERSION "1.0" 42#define DRIVER_AUTHOR "Max Asbock <masbock@us.ibm.com>, Vernon Mauery <vernux@us.ibm.com>" 43#define DRIVER_DESC "IBM ASM Service Processor Driver" 44 45#define err(msg) printk(KERN_ERR "%s: " msg "\n", DRIVER_NAME) 46#define info(msg) printk(KERN_INFO "%s: " msg "\n", DRIVER_NAME) 47 48extern int ibmasm_debug; 49#define dbg(STR, ARGS...) \ 50 do { \ 51 if (ibmasm_debug) \ 52 printk(KERN_DEBUG STR , ##ARGS); \ 53 } while (0) 54 55static inline char *get_timestamp(char *buf) 56{ 57 struct timeval now; 58 do_gettimeofday(&now); 59 sprintf(buf, "%lu.%lu", now.tv_sec, now.tv_usec); 60 return buf; 61} 62 63#define IBMASM_CMD_PENDING 0 64#define IBMASM_CMD_COMPLETE 1 65#define IBMASM_CMD_FAILED 2 66 67#define IBMASM_CMD_TIMEOUT_NORMAL 45 68#define IBMASM_CMD_TIMEOUT_EXTRA 240 69 70#define IBMASM_CMD_MAX_BUFFER_SIZE 0x8000 71 72#define REVERSE_HEARTBEAT_TIMEOUT 120 73 74#define HEARTBEAT_BUFFER_SIZE 0x400 75 76#ifdef IA64 77#define IBMASM_DRIVER_VPD "Lin64 6.08 " 78#else 79#define IBMASM_DRIVER_VPD "Lin32 6.08 " 80#endif 81 82#define SYSTEM_STATE_OS_UP 5 83#define SYSTEM_STATE_OS_DOWN 4 84 85#define IBMASM_NAME_SIZE 16 86 87#define IBMASM_NUM_EVENTS 10 88#define IBMASM_EVENT_MAX_SIZE 2048u 89 90 91struct command { 92 struct list_head queue_node; 93 wait_queue_head_t wait; 94 unsigned char *buffer; 95 size_t buffer_size; 96 int status; 97 struct kobject kobj; 98 spinlock_t *lock; 99}; 100#define to_command(c) container_of(c, struct command, kobj) 101 102static inline void command_put(struct command *cmd) 103{ 104 unsigned long flags; 105 106 spin_lock_irqsave(cmd->lock, flags); 107 kobject_put(&cmd->kobj); 108 spin_unlock_irqrestore(cmd->lock, flags); 109} 110 111static inline void command_get(struct command *cmd) 112{ 113 kobject_get(&cmd->kobj); 114} 115 116 117struct ibmasm_event { 118 unsigned int serial_number; 119 unsigned int data_size; 120 unsigned char data[IBMASM_EVENT_MAX_SIZE]; 121}; 122 123struct 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 130struct 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 139struct reverse_heartbeat { 140 wait_queue_head_t wait; 141 unsigned int stopped; 142}; 143 144struct ibmasm_remote { 145 struct input_dev keybd_dev; 146 struct input_dev mouse_dev; 147}; 148 149struct 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 */ 167extern struct command *ibmasm_new_command(struct service_processor *sp, size_t buffer_size); 168extern void ibmasm_exec_command(struct service_processor *sp, struct command *cmd); 169extern void ibmasm_wait_for_response(struct command *cmd, int timeout); 170extern void ibmasm_receive_command_response(struct service_processor *sp, void *response, size_t size); 171 172/* event processing */ 173extern int ibmasm_event_buffer_init(struct service_processor *sp); 174extern void ibmasm_event_buffer_exit(struct service_processor *sp); 175extern void ibmasm_receive_event(struct service_processor *sp, void *data, unsigned int data_size); 176extern void ibmasm_event_reader_register(struct service_processor *sp, struct event_reader *reader); 177extern void ibmasm_event_reader_unregister(struct service_processor *sp, struct event_reader *reader); 178extern int ibmasm_get_next_event(struct service_processor *sp, struct event_reader *reader); 179extern void ibmasm_cancel_next_event(struct event_reader *reader); 180 181/* heartbeat - from SP to OS */ 182extern void ibmasm_register_panic_notifier(void); 183extern void ibmasm_unregister_panic_notifier(void); 184extern int ibmasm_heartbeat_init(struct service_processor *sp); 185extern void ibmasm_heartbeat_exit(struct service_processor *sp); 186extern void ibmasm_receive_heartbeat(struct service_processor *sp, void *message, size_t size); 187 188/* reverse heartbeat - from OS to SP */ 189extern void ibmasm_init_reverse_heartbeat(struct service_processor *sp, struct reverse_heartbeat *rhb); 190extern int ibmasm_start_reverse_heartbeat(struct service_processor *sp, struct reverse_heartbeat *rhb); 191extern void ibmasm_stop_reverse_heartbeat(struct reverse_heartbeat *rhb); 192 193/* dot commands */ 194extern void ibmasm_receive_message(struct service_processor *sp, void *data, int data_size); 195extern int ibmasm_send_driver_vpd(struct service_processor *sp); 196extern int ibmasm_send_os_state(struct service_processor *sp, int os_state); 197 198/* low level message processing */ 199extern int ibmasm_send_i2o_message(struct service_processor *sp); 200extern irqreturn_t ibmasm_interrupt_handler(int irq, void * dev_id, struct pt_regs *regs); 201 202/* remote console */ 203extern void ibmasm_handle_mouse_interrupt(struct service_processor *sp, struct pt_regs *regs); 204extern int ibmasm_init_remote_input_dev(struct service_processor *sp); 205extern void ibmasm_free_remote_input_dev(struct service_processor *sp); 206 207/* file system */ 208extern int ibmasmfs_register(void); 209extern void ibmasmfs_unregister(void); 210extern void ibmasmfs_add_sp(struct service_processor *sp); 211 212/* uart */ 213#ifdef CONFIG_SERIAL_8250 214extern void ibmasm_register_uart(struct service_processor *sp); 215extern 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