Skip to contentSkip to conversation

IPMI: Support registering for a command per-channel

PATCH In review [email protected] 2 participants 5 messages Jun 23, 2006 – Jun 29, 2006 IPMI

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 IPMI: Support registering for a command per-channel

From: David Barksdale <[email protected]>

This patch adds the ability to register for a command per-channel.

If your BMC supports multiple channels, incoming messages can be differentiated by the channel on which they arrived. In this case it's useful to have the ability to register to receive commands on a specific channel instead the current behaviour of all channels.

---

char/ipmi/ipmi_devintf.c.keep renamed from char/ipmi/ipmi_devintf.c +31 -2
@@ -379,7 +379,7 @@
 			break;
 		}
 
-		rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd);
+		rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd, 255);
 		break;
 	}
 
@@ -392,7 +392,36 @@
 			break;
 		}
 
-		rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd);
+		rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
+			255);
+		break;
+	}
+
+	case IPMICTL_REGISTER_FOR_CMD2:
+	{
+		struct ipmi_cmdspec2 val;
+
+		if (copy_from_user(&val, arg, sizeof(val))) {
+			rv = -EFAULT;
+			break;
+		}
+
+		rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
+			val.chan);
+		break;
+	}
+
+	case IPMICTL_UNREGISTER_FOR_CMD2:
+	{
+		struct ipmi_cmdspec2 val;
+
+		if (copy_from_user(&val, arg, sizeof(val))) {
+			rv = -EFAULT;
+			break;
+		}
+
+		rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
+			val.chan);
 		break;
 	}
 
char/ipmi/ipmi_msghandler.c.keep renamed from char/ipmi/ipmi_msghandler.c +21 -10
@@ -96,6 +96,7 @@
 	ipmi_user_t   user;
 	unsigned char netfn;
 	unsigned char cmd;
+	unsigned char chan;
 
 	/*
 	 * This is used to form a linked lised during mass deletion.
@@ -921,12 +922,15 @@
 
 static struct cmd_rcvr *find_cmd_rcvr(ipmi_smi_t    intf,
 				      unsigned char netfn,
-				      unsigned char cmd)
+				      unsigned char cmd,
+				      unsigned char chan)
 {
 	struct cmd_rcvr *rcvr;
 
 	list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link) {
-		if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd))
+		if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
+			&& ((chan == 255) || (rcvr->chan == 255)
+			|| (rcvr->chan == chan)))
 			return rcvr;
 	}
 	return NULL;
@@ -934,7 +938,8 @@
 
 int ipmi_register_for_cmd(ipmi_user_t   user,
 			  unsigned char netfn,
-			  unsigned char cmd)
+			  unsigned char cmd,
+			  unsigned char chan)
 {
 	ipmi_smi_t      intf = user->intf;
 	struct cmd_rcvr *rcvr;
@@ -947,11 +952,12 @@
 		return -ENOMEM;
 	rcvr->cmd = cmd;
 	rcvr->netfn = netfn;
+	rcvr->chan = chan;
 	rcvr->user = user;
 
 	down(&intf->cmd_rcvrs_lock);
-	/* Make sure the command/netfn is not already registered. */
-	entry = find_cmd_rcvr(intf, netfn, cmd);
+	/* Make sure the command/netfn/chan is not already registered. */
+	entry = find_cmd_rcvr(intf, netfn, cmd, chan);
 	if (entry) {
 		rv = -EBUSY;
 		goto out_unlock;
@@ -969,14 +975,15 @@
 
 int ipmi_unregister_for_cmd(ipmi_user_t   user,
 			    unsigned char netfn,
-			    unsigned char cmd)
+			    unsigned char cmd,
+			    unsigned char chan)
 {
 	ipmi_smi_t      intf = user->intf;
 	struct cmd_rcvr *rcvr;
 
 	down(&intf->cmd_rcvrs_lock);
-	/* Make sure the command/netfn is not already registered. */
-	rcvr = find_cmd_rcvr(intf, netfn, cmd);
+	/* Make sure the command/netfn/chan is already registered. */
+	rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
 	if ((rcvr) && (rcvr->user == user)) {
 		list_del_rcu(&rcvr->link);
 		up(&intf->cmd_rcvrs_lock);
@@ -2036,6 +2043,7 @@
 	int                      rv = 0;
 	unsigned char            netfn;
 	unsigned char            cmd;
+	unsigned char            chan;
 	ipmi_user_t              user = NULL;
 	struct ipmi_ipmb_addr    *ipmb_addr;
 	struct ipmi_recv_msg     *recv_msg;
@@ -2056,9 +2064,10 @@
 
 	netfn = msg->rsp[4] >> 2;
 	cmd = msg->rsp[8];
+	chan = msg->rsp[3] & 0xf;
 
 	rcu_read_lock();
-	rcvr = find_cmd_rcvr(intf, netfn, cmd);
+	rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
 	if (rcvr) {
 		user = rcvr->user;
 		kref_get(&user->refcount);
@@ -2216,6 +2225,7 @@
 	int                      rv = 0;
 	unsigned char            netfn;
 	unsigned char            cmd;
+	unsigned char            chan;
 	ipmi_user_t              user = NULL;
 	struct ipmi_lan_addr     *lan_addr;
 	struct ipmi_recv_msg     *recv_msg;
@@ -2236,9 +2246,10 @@
 
 	netfn = msg->rsp[6] >> 2;
 	cmd = msg->rsp[10];
+	chan = msg->rsp[3] & 0xf;
 
 	rcu_read_lock();
-	rcvr = find_cmd_rcvr(intf, netfn, cmd);
+	rcvr = find_cmd_rcvr(intf, netfn, cmd, chan);
 	if (rcvr) {
 		user = rcvr->user;
 		kref_get(&user->refcount);
linux/ipmi.h.keep renamed from linux/ipmi.h +32 -6
@@ -353,18 +353,20 @@
 
 /*
  * When commands come in to the SMS, the user can register to receive
- * them.  Only one user can be listening on a specific netfn/cmd pair
+ * them.  Only one user can be listening on a specific netfn/cmd/chan tuple
  * at a time, you will get an EBUSY error if the command is already
- * registered.  If a command is received that does not have a user
- * registered, the driver will automatically return the proper
- * error.
+ * registered.  A channel number of 255 signifies listening on all channels.
+ * If a command is received that does not have a user registered, the driver
+ * will automatically return the proper error.
  */
 int ipmi_register_for_cmd(ipmi_user_t   user,
 			  unsigned char netfn,
-			  unsigned char cmd);
+			  unsigned char cmd,
+			  unsigned char chan);
 int ipmi_unregister_for_cmd(ipmi_user_t   user,
 			    unsigned char netfn,
-			    unsigned char cmd);
+			    unsigned char cmd,
+			    unsigned char chan);
 
 /*
  * Allow run-to-completion mode to be set for the interface of
@@ -558,6 +560,14 @@
 	unsigned char cmd;
 };
 
+/* Register to get commands from other entities on a particular channel. */
+struct ipmi_cmdspec2
+{
+	unsigned char netfn;
+	unsigned char cmd;
+	unsigned char chan;
+};
+
 /* 
  * Register to receive a specific command.  error values:
  *   - EFAULT - an address supplied was invalid.
@@ -575,6 +585,22 @@
 					     struct ipmi_cmdspec)
 
 /* 
+ * Register to receive a specific command on a specific channel.  error values:
+ *   - EFAULT - an address supplied was invalid.
+ *   - EBUSY - The netfn/cmd/chan supplied was already in use.
+ *   - ENOMEM - could not allocate memory for the entry.
+ */
+#define IPMICTL_REGISTER_FOR_CMD2	_IOR(IPMI_IOC_MAGIC, 28,	\
+					     struct ipmi_cmdspec2)
+/*
+ * Unregister a regsitered command.  error values:
+ *  - EFAULT - an address supplied was invalid.
+ *  - ENOENT - The netfn/cmd/chan was not found registered for this user.
+ */
+#define IPMICTL_UNREGISTER_FOR_CMD2	_IOR(IPMI_IOC_MAGIC, 29,	\
+					     struct ipmi_cmdspec2)
+
+/* 
  * Set whether this interface receives events.  Note that the first
  * user registered for events will get all pending events for the
  * interface.  error values:
#1 lore raw
Quoted 10 lines · [email protected] wrote:

From: David Barksdale <[email protected]>

This patch adds the ability to register for a command per-channel.

If your BMC supports multiple channels, incoming messages can be differentiated by the channel on which they arrived. In this case it's useful to have the ability to register to receive commands on a specific channel instead the current behaviour of all channels.

Sorry for the long delay on this. I like the patch in general, there are a few things I'd like to fix in it, though:

* Instead of naming the IOCTLs xxx_CMD2, could you name them xxx_CMD_CHANNEL, or something that conveys a little more meaning?

* The command unregister function needs to use a different matching function now that you have to allow non-exact matches for the channels. You still need an exact match for unregistering.

* Someone mentioned using a bitmask for the channels you are registering. I think that's a good idea. IPMI only allows 16 channels max, so an unsigned int should be plenty. Add a define for all channels and for setting a specific channel.

Thanks,

-Corey

#2 lore raw
Quoted 9 lines · Corey Minyard
Quoted 8 lines · [email protected] wrote:

From: David Barksdale <[email protected]>

This patch adds the ability to register for a command per-channel.

If your BMC supports multiple channels, incoming messages can be differentiated by the channel on which they arrived. In this case it's useful to have the ability to register to receive commands on a specific channel instead the current behaviour of all channels.

Quoted 6 lines

Sorry for the long delay on this. I like the patch in general, there are a few things I'd like to fix in it, though:

* Instead of naming the IOCTLs xxx_CMD2, could you name them xxx_CMD_CHANNEL, or something that conveys a little more meaning?

Done.

Quoted 5 lines

* The command unregister function needs to use a different matching function now that you have to allow non-exact matches for the channels. You still need an exact match for unregistering.

It behaves more reasonably now that the channels are specified as bitmasks. It will unregister all channels you specify and only report an error if it couldn't find anything to unregister.

Quoted 6 lines

* Someone mentioned using a bitmask for the channels you are registering. I think that's a good idea. IPMI only allows 16 channels max, so an unsigned int should be plenty. Add a define for all channels and for setting a specific channel.

Done.

Quoted 4 lines

Thanks,

-Corey

Please consider this updated patch. Thanks.

--
This patch is to be used in place of the last one.

drivers/char/ipmi/ipmi_devintf.c +32 -2
diff -rup linux-2.6.17.1.orig/drivers/char/ipmi/ipmi_devintf.c linux-2.6.17.1/drivers/char/ipmi/ipmi_devintf.c
@@ -379,7 +379,8 @@ static int ipmi_ioctl(struct inode  *ino
 			break;
 		}
 
-		rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd);
+		rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
+			IPMI_CHAN_ALL);
 		break;
 	}
 
@@ -392,7 +393,36 @@ static int ipmi_ioctl(struct inode  *ino
 			break;
 		}
 
-		rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd);
+		rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
+			IPMI_CHAN_ALL);
+		break;
+	}
+
+	case IPMICTL_REGISTER_FOR_CMD_CHANS:
+	{
+		struct ipmi_cmdspec_chans val;
+
+		if (copy_from_user(&val, arg, sizeof(val))) {
+			rv = -EFAULT;
+			break;
+		}
+
+		rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
+			val.chans);
+		break;
+	}
+
+	case IPMICTL_UNREGISTER_FOR_CMD_CHANS:
+	{
+		struct ipmi_cmdspec_chans val;
+
+		if (copy_from_user(&val, arg, sizeof(val))) {
+			rv = -EFAULT;
+			break;
+		}
+
+		rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
+			val.chans);
 		break;
 	}
 
drivers/char/ipmi/ipmi_msghandler.c +56 -19

152 lines not on this page · raw message

include/linux/ipmi.h +32 -4
diff -rup linux-2.6.17.1.orig/include/linux/ipmi.h linux-2.6.17.1/include/linux/ipmi.h
@@ -148,6 +148,7 @@ struct ipmi_lan_addr
  */
 #define IPMI_BMC_CHANNEL  0xf
 #define IPMI_NUM_CHANNELS 0x10
+#define IPMI_CHAN_ALL     (( 1 << IPMI_NUM_CHANNELS ) - 1 )
 
 
 /*
@@ -354,18 +355,21 @@ int ipmi_request_supply_msgs(ipmi_user_t
 
 /*
  * When commands come in to the SMS, the user can register to receive
- * them.  Only one user can be listening on a specific netfn/cmd pair
+ * them.  Only one user can be listening on a specific netfn/cmd/chan tuple
  * at a time, you will get an EBUSY error if the command is already
  * registered.  If a command is received that does not have a user
  * registered, the driver will automatically return the proper
- * error.
+ * error.  Channels are specified as a bitfield, use IPMI_CHAN_ALL to
+ * mean all channels.
  */
 int ipmi_register_for_cmd(ipmi_user_t   user,
 			  unsigned char netfn,
-			  unsigned char cmd);
+			  unsigned char cmd,
+			  unsigned int  chans);
 int ipmi_unregister_for_cmd(ipmi_user_t   user,
 			    unsigned char netfn,
-			    unsigned char cmd);
+			    unsigned char cmd,
+			    unsigned int  chans);
 
 /*
  * Allow run-to-completion mode to be set for the interface of
@@ -575,6 +579,30 @@ struct ipmi_cmdspec
 #define IPMICTL_UNREGISTER_FOR_CMD	_IOR(IPMI_IOC_MAGIC, 15,	\
 					     struct ipmi_cmdspec)
 
+/* Register to get commands from other entities on specific channels. */
+struct ipmi_cmdspec_chans
+{
+	unsigned char netfn;
+	unsigned char cmd;
+	unsigned int  chans;
+};
+
+/* 
+ * Register to receive a specific command on specific channels.  error values:
+ *   - EFAULT - an address supplied was invalid.
+ *   - EBUSY - One of the netfn/cmd/chans supplied was already in use.
+ *   - ENOMEM - could not allocate memory for the entry.
+ */
+#define IPMICTL_REGISTER_FOR_CMD_CHANS	_IOR(IPMI_IOC_MAGIC, 28,	\
+					     struct ipmi_cmdspec_chans)
+/*
+ * Unregister some netfn/cmd/chans.  error values:
+ *  - EFAULT - an address supplied was invalid.
+ *  - ENOENT - None of the netfn/cmd/chans were found registered for this user.
+ */
+#define IPMICTL_UNREGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 29,	\
+					     struct ipmi_cmdspec_chans)
+
 /* 
  * Set whether this interface receives events.  Note that the first
  * user registered for events will get all pending events for the
#3 lore raw

This patch looks good to me. I added the following as a header. Is this ok? The "Signed-off-by" line is pretty important in patches.

Thanks,

-Corey
--

This patch adds the ability to register for a command per-channel in the IPMI driver.

If your BMC supports multiple channels, incoming messages can be differentiated by the channel on which they arrived. In this case it's useful to have the ability to register to receive commands on a specific channel instead the current behaviour of all channels.

#4 lore raw
Quoted 11 lines · Corey Minyard

This patch looks good to me. I added the following as a header. Is this ok? The "Signed-off-by" line is pretty important in patches.

Thanks,

-Corey
--

This patch adds the ability to register for a command per-channel in the IPMI driver.

Quoted 7 lines

If your BMC supports multiple channels, incoming messages can be differentiated by the channel on which they arrived. In this case it's useful to have the ability to register to receive commands on a specific channel instead the current behaviour of all channels.

Affirmative!