2 * IBM ASM Service Processor Device Driver
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 * Copyright (C) IBM Corporation, 2004
20 * Author: Max Asböck <amax@us.ibm.com>
25 * Parts of this code are based on an article by Jonathan Corbet
26 * that appeared in Linux Weekly News.
31 * The IBMASM file virtual filesystem. It creates the following hierarchy
32 * dymamically when mounted from user space:
38 * | |-- reverse_heartbeat
49 * |-- reverse_heartbeat
55 * For each service processor the following files are created:
57 * command: execute dot commands
58 * write: execute a dot command on the service processor
59 * read: return the result of a previously executed dot command
61 * events: listen for service processor events
62 * read: sleep (interruptible) until an event occurs
63 * write: wakeup sleeping event listener
65 * reverse_heartbeat: send a heartbeat to the service processor
66 * read: sleep (interruptible) until the reverse heartbeat fails
67 * write: wakeup sleeping heartbeat listener
71 * remote_video/width: control remote display settings
77 #include <linux/pagemap.h>
78 #include <asm/uaccess.h>
82 #include "dot_command.h"
84 #define IBMASMFS_MAGIC 0x66726f67
86 static LIST_HEAD(service_processors);
88 static struct inode *ibmasmfs_make_inode(struct super_block *sb, int mode);
89 static void ibmasmfs_create_files (struct super_block *sb, struct dentry *root);
90 static int ibmasmfs_fill_super (struct super_block *sb, void *data, int silent);
93 static int ibmasmfs_get_super(struct file_system_type *fst,
94 int flags, const char *name, void *data,
97 return get_sb_single(fst, flags, data, ibmasmfs_fill_super, mnt);
100 static struct super_operations ibmasmfs_s_ops = {
101 .statfs = simple_statfs,
102 .drop_inode = generic_delete_inode,
105 static const struct file_operations *ibmasmfs_dir_ops = &simple_dir_operations;
107 static struct file_system_type ibmasmfs_type = {
108 .owner = THIS_MODULE,
110 .get_sb = ibmasmfs_get_super,
111 .kill_sb = kill_litter_super,
114 static int ibmasmfs_fill_super (struct super_block *sb, void *data, int silent)
117 struct dentry *root_dentry;
119 sb->s_blocksize = PAGE_CACHE_SIZE;
120 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
121 sb->s_magic = IBMASMFS_MAGIC;
122 sb->s_op = &ibmasmfs_s_ops;
125 root = ibmasmfs_make_inode (sb, S_IFDIR | 0500);
129 root->i_op = &simple_dir_inode_operations;
130 root->i_fop = ibmasmfs_dir_ops;
132 root_dentry = d_alloc_root(root);
137 sb->s_root = root_dentry;
139 ibmasmfs_create_files(sb, root_dentry);
143 static struct inode *ibmasmfs_make_inode(struct super_block *sb, int mode)
145 struct inode *ret = new_inode(sb);
149 ret->i_uid = ret->i_gid = 0;
151 ret->i_atime = ret->i_mtime = ret->i_ctime = CURRENT_TIME;
156 static struct dentry *ibmasmfs_create_file (struct super_block *sb,
157 struct dentry *parent,
159 struct file_operations *fops,
163 struct dentry *dentry;
166 dentry = d_alloc_name(parent, name);
170 inode = ibmasmfs_make_inode(sb, S_IFREG | mode);
177 inode->i_private = data;
179 d_add(dentry, inode);
183 static struct dentry *ibmasmfs_create_dir (struct super_block *sb,
184 struct dentry *parent,
187 struct dentry *dentry;
190 dentry = d_alloc_name(parent, name);
194 inode = ibmasmfs_make_inode(sb, S_IFDIR | 0500);
200 inode->i_op = &simple_dir_inode_operations;
201 inode->i_fop = ibmasmfs_dir_ops;
203 d_add(dentry, inode);
207 int ibmasmfs_register(void)
209 return register_filesystem(&ibmasmfs_type);
212 void ibmasmfs_unregister(void)
214 unregister_filesystem(&ibmasmfs_type);
217 void ibmasmfs_add_sp(struct service_processor *sp)
219 list_add(&sp->node, &service_processors);
222 /* struct to save state between command file operations */
223 struct ibmasmfs_command_data {
224 struct service_processor *sp;
225 struct command *command;
228 /* struct to save state between event file operations */
229 struct ibmasmfs_event_data {
230 struct service_processor *sp;
231 struct event_reader reader;
235 /* struct to save state between reverse heartbeat file operations */
236 struct ibmasmfs_heartbeat_data {
237 struct service_processor *sp;
238 struct reverse_heartbeat heartbeat;
242 static int command_file_open(struct inode *inode, struct file *file)
244 struct ibmasmfs_command_data *command_data;
246 if (!inode->i_private)
249 command_data = kmalloc(sizeof(struct ibmasmfs_command_data), GFP_KERNEL);
253 command_data->command = NULL;
254 command_data->sp = inode->i_private;
255 file->private_data = command_data;
259 static int command_file_close(struct inode *inode, struct file *file)
261 struct ibmasmfs_command_data *command_data = file->private_data;
263 if (command_data->command)
264 command_put(command_data->command);
270 static ssize_t command_file_read(struct file *file, char __user *buf, size_t count, loff_t *offset)
272 struct ibmasmfs_command_data *command_data = file->private_data;
279 if (count == 0 || count > IBMASM_CMD_MAX_BUFFER_SIZE)
284 spin_lock_irqsave(&command_data->sp->lock, flags);
285 cmd = command_data->command;
287 spin_unlock_irqrestore(&command_data->sp->lock, flags);
290 command_data->command = NULL;
291 spin_unlock_irqrestore(&command_data->sp->lock, flags);
293 if (cmd->status != IBMASM_CMD_COMPLETE) {
297 len = min(count, cmd->buffer_size);
298 if (copy_to_user(buf, cmd->buffer, len)) {
307 static ssize_t command_file_write(struct file *file, const char __user *ubuff, size_t count, loff_t *offset)
309 struct ibmasmfs_command_data *command_data = file->private_data;
315 if (count == 0 || count > IBMASM_CMD_MAX_BUFFER_SIZE)
320 /* commands are executed sequentially, only one command at a time */
321 if (command_data->command)
324 cmd = ibmasm_new_command(command_data->sp, count);
328 if (copy_from_user(cmd->buffer, ubuff, count)) {
333 spin_lock_irqsave(&command_data->sp->lock, flags);
334 if (command_data->command) {
335 spin_unlock_irqrestore(&command_data->sp->lock, flags);
339 command_data->command = cmd;
340 spin_unlock_irqrestore(&command_data->sp->lock, flags);
342 ibmasm_exec_command(command_data->sp, cmd);
343 ibmasm_wait_for_response(cmd, get_dot_command_timeout(cmd->buffer));
348 static int event_file_open(struct inode *inode, struct file *file)
350 struct ibmasmfs_event_data *event_data;
351 struct service_processor *sp;
353 if (!inode->i_private)
356 sp = inode->i_private;
358 event_data = kmalloc(sizeof(struct ibmasmfs_event_data), GFP_KERNEL);
362 ibmasm_event_reader_register(sp, &event_data->reader);
365 event_data->active = 0;
366 file->private_data = event_data;
370 static int event_file_close(struct inode *inode, struct file *file)
372 struct ibmasmfs_event_data *event_data = file->private_data;
374 ibmasm_event_reader_unregister(event_data->sp, &event_data->reader);
379 static ssize_t event_file_read(struct file *file, char __user *buf, size_t count, loff_t *offset)
381 struct ibmasmfs_event_data *event_data = file->private_data;
382 struct event_reader *reader = &event_data->reader;
383 struct service_processor *sp = event_data->sp;
389 if (count == 0 || count > IBMASM_EVENT_MAX_SIZE)
394 spin_lock_irqsave(&sp->lock, flags);
395 if (event_data->active) {
396 spin_unlock_irqrestore(&sp->lock, flags);
399 event_data->active = 1;
400 spin_unlock_irqrestore(&sp->lock, flags);
402 ret = ibmasm_get_next_event(sp, reader);
406 if (count < reader->data_size) {
411 if (copy_to_user(buf, reader->data, reader->data_size)) {
415 ret = reader->data_size;
418 event_data->active = 0;
422 static ssize_t event_file_write(struct file *file, const char __user *buf, size_t count, loff_t *offset)
424 struct ibmasmfs_event_data *event_data = file->private_data;
433 ibmasm_cancel_next_event(&event_data->reader);
437 static int r_heartbeat_file_open(struct inode *inode, struct file *file)
439 struct ibmasmfs_heartbeat_data *rhbeat;
441 if (!inode->i_private)
444 rhbeat = kmalloc(sizeof(struct ibmasmfs_heartbeat_data), GFP_KERNEL);
448 rhbeat->sp = inode->i_private;
450 ibmasm_init_reverse_heartbeat(rhbeat->sp, &rhbeat->heartbeat);
451 file->private_data = rhbeat;
455 static int r_heartbeat_file_close(struct inode *inode, struct file *file)
457 struct ibmasmfs_heartbeat_data *rhbeat = file->private_data;
463 static ssize_t r_heartbeat_file_read(struct file *file, char __user *buf, size_t count, loff_t *offset)
465 struct ibmasmfs_heartbeat_data *rhbeat = file->private_data;
471 if (count == 0 || count > 1024)
476 /* allow only one reverse heartbeat per process */
477 spin_lock_irqsave(&rhbeat->sp->lock, flags);
478 if (rhbeat->active) {
479 spin_unlock_irqrestore(&rhbeat->sp->lock, flags);
483 spin_unlock_irqrestore(&rhbeat->sp->lock, flags);
485 result = ibmasm_start_reverse_heartbeat(rhbeat->sp, &rhbeat->heartbeat);
491 static ssize_t r_heartbeat_file_write(struct file *file, const char __user *buf, size_t count, loff_t *offset)
493 struct ibmasmfs_heartbeat_data *rhbeat = file->private_data;
503 ibmasm_stop_reverse_heartbeat(&rhbeat->heartbeat);
508 static int remote_settings_file_open(struct inode *inode, struct file *file)
510 file->private_data = inode->i_private;
514 static int remote_settings_file_close(struct inode *inode, struct file *file)
519 static ssize_t remote_settings_file_read(struct file *file, char __user *buf, size_t count, loff_t *offset)
521 void __iomem *address = (void __iomem *)file->private_data;
529 if (count == 0 || count > 1024)
534 page = (unsigned char *)__get_free_page(GFP_KERNEL);
538 value = readl(address);
539 len = sprintf(page, "%d\n", value);
541 if (copy_to_user(buf, page, len)) {
549 free_page((unsigned long)page);
553 static ssize_t remote_settings_file_write(struct file *file, const char __user *ubuff, size_t count, loff_t *offset)
555 void __iomem *address = (void __iomem *)file->private_data;
561 if (count == 0 || count > 1024)
566 buff = kmalloc (count + 1, GFP_KERNEL);
570 memset(buff, 0x0, count + 1);
572 if (copy_from_user(buff, ubuff, count)) {
577 value = simple_strtoul(buff, NULL, 10);
578 writel(value, address);
584 static struct file_operations command_fops = {
585 .open = command_file_open,
586 .release = command_file_close,
587 .read = command_file_read,
588 .write = command_file_write,
591 static struct file_operations event_fops = {
592 .open = event_file_open,
593 .release = event_file_close,
594 .read = event_file_read,
595 .write = event_file_write,
598 static struct file_operations r_heartbeat_fops = {
599 .open = r_heartbeat_file_open,
600 .release = r_heartbeat_file_close,
601 .read = r_heartbeat_file_read,
602 .write = r_heartbeat_file_write,
605 static struct file_operations remote_settings_fops = {
606 .open = remote_settings_file_open,
607 .release = remote_settings_file_close,
608 .read = remote_settings_file_read,
609 .write = remote_settings_file_write,
613 static void ibmasmfs_create_files (struct super_block *sb, struct dentry *root)
615 struct list_head *entry;
616 struct service_processor *sp;
618 list_for_each(entry, &service_processors) {
620 struct dentry *remote_dir;
621 sp = list_entry(entry, struct service_processor, node);
622 dir = ibmasmfs_create_dir(sb, root, sp->dirname);
626 ibmasmfs_create_file(sb, dir, "command", &command_fops, sp, S_IRUSR|S_IWUSR);
627 ibmasmfs_create_file(sb, dir, "event", &event_fops, sp, S_IRUSR|S_IWUSR);
628 ibmasmfs_create_file(sb, dir, "reverse_heartbeat", &r_heartbeat_fops, sp, S_IRUSR|S_IWUSR);
630 remote_dir = ibmasmfs_create_dir(sb, dir, "remote_video");
634 ibmasmfs_create_file(sb, remote_dir, "width", &remote_settings_fops, (void *)display_width(sp), S_IRUSR|S_IWUSR);
635 ibmasmfs_create_file(sb, remote_dir, "height", &remote_settings_fops, (void *)display_height(sp), S_IRUSR|S_IWUSR);
636 ibmasmfs_create_file(sb, remote_dir, "depth", &remote_settings_fops, (void *)display_depth(sp), S_IRUSR|S_IWUSR);