Driver for IBM RSA service processor (1/2)

Here is a device driver for the IBM xSeries RSA service processor. The ibmasm driver is mainly intended to be used in conjunction with a user space API and systems management applications that need to get in-band access to the service processor, such as sending commands or waiting for events. For the remote video feature the driver relays remote mouse and keyboard events to user space.
By itself the driver also allows the OS to make use the UART on the service processor board as a regular serial line.

The user interface to the driver is a custom file system. It does not use sysfs since the operations on the files are somewhat beyond the one file / one value rule for sysfs. Since it is not strictly a char driver I put it into the drivers/misc directory.

The patch is fairly big, therefore I split it up into the file system part and the everything-else part.

Any feedback is greatly appreciated.

Regards,

Max

Here is the non-filesytem part:

diff -urN linux-2.6.1/drivers/Kconfig linux-2.6.1-ibmasm/drivers/Kconfig
@@ -38,7 +38,7 @@
 
 source "drivers/char/Kconfig"
 
-# source "drivers/misc/Kconfig"
+source "drivers/misc/Kconfig"
 
 source "drivers/media/Kconfig"
 

diff -urN linux-2.6.1/drivers/misc/ibmasm/Makefile linux-2.6.1-ibmasm/drivers/misc/ibmasm/Makefile
@@ -0,0 +1,13 @@
+
+obj-$(CONFIG_IBM_ASM) := ibmasm.o
+
+ibmasm-objs :=	module.o      \
+		ibmasmfs.o    \
+		event.o       \
+		command.o     \
+		remote.o      \
+		heartbeat.o   \
+		r_heartbeat.o \
+		dot_command.o \
+		lowlevel.o    \
+		uart.o

diff -urN linux-2.6.1/drivers/misc/Kconfig linux-2.6.1-ibmasm/drivers/misc/Kconfig
@@ -4,5 +4,21 @@
 
 menu "Misc devices"
 
+config IBM_ASM
+	tristate "Device driver for IBM RSA service processor"
+	default n
+	---help---
+	  This option enables device driver support for in-band access to the
+	  IBM RSA (Condor) service processor in eServer xSeries systems.
+	  The ibmasm device driver allows user space application to access
+	  ASM (Advanced Systems Management) functions on the service
+	  processor. The driver is meant to be used in conjunction with
+	  a user space API.
+	  The ibmasm driver also enables the OS to use the UART on the
+          service processor board as a regular serial port.
+	  
+
+	  If unsure, say N.
+
 endmenu
 

diff -urN linux-2.6.1/drivers/misc/Makefile linux-2.6.1-ibmasm/drivers/misc/Makefile
@@ -1,4 +1,6 @@
 #
 # Makefile for misc devices that really don't fit anywhere else.
 #
-obj- := misc.o	# Dummy rule to force built-in.o to be made
+obj- := misc.o  # Dummy rule to force built-in.o to be made
+
+obj-$(CONFIG_IBM_ASM)	+= ibmasm/

On Mon, 2 Feb 2004 11:29:53 -0800 Max Asbock <[email protected]> wrote:

| Here is a device driver for the IBM xSeries RSA service processor.
| The ibmasm driver is mainly intended to be used in conjunction with a user space 
| API and systems management applications that need to get in-band access to
| the service processor, such as sending commands or waiting for events.
| For the remote video feature the driver relays remote mouse and keyboard 
| events to user space. 
| By itself the driver also allows the OS to make use the UART on the service
| processor board as a regular serial line.
| 
| The user interface to the driver is a custom file system. It does not use sysfs since
| the operations on the files are somewhat beyond the one file / one value rule for sysfs.
| Since it is not strictly a char driver I put it into the drivers/misc directory.
| 
| The patch is fairly big, therefore I split it up into the file system part and the
| everything-else part.
| 
| Any feedback is greatly appreciated.

Hi,

Need to be consistent with spacing in "if" -- don't add spaces on both sides of '(' and ')'.

| + if (buffer_size > IBMASM_CMD_MAX_BUFFER_SIZE)
| + return NULL;

Several good, like above....

| +static struct command *dequeue_command(struct service_processor *sp)
| +{
| +	struct command *cmd;
| +	struct list_head *next;
| +
| +	if ( list_empty(&sp->command_queue) )
| +		return NULL;

Nope, no cookie for this one and others below...

| +static inline void do_exec_command(struct service_processor *sp)
| +{
| +	if ( ibmasm_send_i2o_message(sp) ) {
| +		sp->current_command->status = IBMASM_CMD_FAILED;
| +		exec_next_command(sp);
| +	}
| +}

| +	if ( !sp->current_command ) {
| +		command_get(cmd);
| +		sp->current_command = cmd;
| +		spin_unlock_irqrestore(&sp->lock, flags);
| +
| +		do_exec_command(sp);

| +	if ( sp->current_command ) {
| +		command_get(sp->current_command);
| +		spin_unlock_irqrestore(&sp->lock, flags);
| +		do_exec_command(sp);
| +	} else {
| +		spin_unlock_irqrestore(&sp->lock, flags);
| +	}

| diff -urN linux-2.6.1/drivers/misc/ibmasm/dot_command.c linux-2.6.1-ibmasm/drivers/misc/ibmasm/dot_command.c
| --- linux-2.6.1/drivers/misc/ibmasm/dot_command.c	1969-12-31 16:00:00.000000000 -0800
| +++ linux-2.6.1-ibmasm/drivers/misc/ibmasm/dot_command.c	2004-01-22 11:10:20.000000000 -0800

| diff -urN linux-2.6.1/drivers/misc/ibmasm/event.c linux-2.6.1-ibmasm/drivers/misc/ibmasm/event.c
| --- linux-2.6.1/drivers/misc/ibmasm/event.c	1969-12-31 16:00:00.000000000 -0800
| +++ linux-2.6.1-ibmasm/drivers/misc/ibmasm/event.c	2004-01-20 11:16:29.000000000 -0800

| +/**
| + * receive_event
| + * Called by the interrupt handler when a dot command of type sp_event is
| + * received.
| + * Store the event in the circular event buffer, wake up any sleeping
| + * event readers.
| + * There is no reader marker in the buffer, therefore readers are
| + * responsible for keeping up with the writer, or they will loose events.

lose

| +	/* advance indices in the buffer */
| +	buffer->next_index = ++(buffer->next_index) % IBMASM_NUM_EVENTS;
| +	buffer->next_serial_number++;

Is
+#define IBMASM_NUM_EVENTS 10
not configurable?

| + if ( wait_event_interruptible(reader->wait, event_available(buffer, reader)) )
| + return -ERESTARTSYS;

:(

| + if (!event_available(buffer, reader))
| + return 0;

:)

I'll try to look at more of it later today.

--
~Randy
kernel-janitors project: http://janitor.kernelnewbies.org/

Max Asbock <[email protected]> :

[...]

[...]

[...]

[...]