Wireshark-dev: Re: [Wireshark-dev] [PATCH] Fix IPMI Completion Codes
From: Flavio Leitner <[email protected]>
Date: Wed, 20 Jun 2007 14:26:14 -0300
Hi Al Chu,

What you think about this patch?
Thanks for your review and suggestions.

-Flavio

On Tue, May 29, 2007 at 01:56:45PM -0700, Al Chu wrote:
> Hi Flavio,
> 
> (please, keep myself on CC as I'm not subscribed)
> 
> A few thoughts on your patch:
> 
> 1) I think you should move the original:
> 
>        /* added by lane */
>         { 0x81, "cannot execute command, SEL erase in progress" },
> 
> from ipmi_ccode_vals[] into a new array and add command specific error
> support into get_ccode_cmd_text(). 
> 
> 2) I believe your patch works for this particular instance, b/c in 0x39
> is only used by the get session challenge command.  However (if you take
> a look in table 44-11), there are many "commands" that use the same hex
> "cmd" code.  (i.e. both get device id and get chassis status and get set
> lan configuration parameters use cmd == 0x01.)  So get_ccode_cmd_text()
> should key off both the cmd and the network function in order to
> determine which command specific error code string array to use.
> 
> 3)
> 
> The coding requirements and semantics for wireshark are largely unknown
> to me, so I apologize if what I say below is faux pas for wireshark.
> 
> If a command specific error code is returned but doesn't have an command
> specific array of strings supported, it should instead say "Command
> Specific Error" instead of just "Unknown".
> 
> Al
> 
> -- 
> Albert Chu
> [email protected]
> 925-422-5311
> Computer Scientist
> High Performance Systems Division
> Lawrence Livermore National Laboratory

-- 
Flávio
[PATCH]: Fix IPMI Completion Code translation.

The IPMI Completion Codes in range 80-BEh are command-specific so 
it must consider the command and netfn before translate it.

The table is based on IPMIv2_0rev1_0.pdf
 
Signed-of-by Flavio Leitner <[email protected]>

Index: upstream-wireshark/epan/dissectors/packet-ipmi.c
===================================================================
--- upstream-wireshark.orig/epan/dissectors/packet-ipmi.c
+++ upstream-wireshark/epan/dissectors/packet-ipmi.c
@@ -571,8 +571,6 @@ static const true_false_string ipmi_payl
 
 static const value_string ipmi_ccode_vals[] = {
 	{ 0x00, "Command completed normally" },
-	/* added by lane */
-	{ 0x81, "cannot execute command, SEL erase in progress" },
 	/***************/
 	{ 0xc0, "Node busy" },
 	{ 0xc1, "Unrecognized or unsupported command" },
@@ -1630,6 +1628,15 @@ typedef struct _ipmi_cmd_dissect{
 } ipmi_cmd_dissect;
 
 
+/* ipmi completion command dissector struct */
+
+typedef struct _ipmi_complcmd_dissect{
+  guint8  netfn;
+  guint8  cmd;
+  guint8  cmpl;
+  const gchar   *strptr;
+} ipmi_complcmd_dissect;
+
 
 /* Sensor/Event  NetFN (0x04) */
 
@@ -3940,6 +3947,129 @@ static const ipmi_cmd_dissect ipmi_cmd_a
 
 /***************************************************/
 
+static const ipmi_complcmd_dissect ipmi_complcmd_array[] = {
+
+	/* netfn, cmd, completion, str */
+	/* Chassis netfn (0x00) */
+	{ 0x00,	0x08,	0x80,	"Parameter not supported" },
+	{ 0x00,	0x08,	0x81,	"Attempt to set in progress value" },
+	{ 0x00,	0x08,	0x82,	"Attempt to write read-only value" },
+	{ 0x00,	0x09,	0x80,	"Parameter not supported" },
+	/* Bridge netfn (0x02) */
+/* incomplete completion codes
+	{ 0x02,	0x00,	0x0,	NULL},
+	{ 0x02,	0x01,	0x0,	NULL},
+	{ 0x02,	0x02,	0x0,	NULL},
+	{ 0x02,	0x03,	0x0,	NULL},
+	{ 0x02,	0x04,	0x0,	NULL},
+	{ 0x02,	0x05,	0x0,	NULL},
+	{ 0x02,	0x06,	0x0,	NULL},
+	{ 0x02,	0x07,	0x0,	NULL},
+	{ 0x02,	0x08,	0x0,	NULL},
+	{ 0x02,	0x09,	0x0,	NULL},
+	{ 0x02,	0x0a,	0x0,	NULL},
+	{ 0x02,	0x0b,	0x0,	NULL},
+	{ 0x02,	0x0c,	0x0,	NULL},
+	{ 0x02,	0x10,	0x0,	NULL},
+	{ 0x02,	0x11,	0x0,	NULL},
+	{ 0x02,	0x12,	0x0,	NULL},
+	{ 0x02,	0x13,	0x0,	NULL},
+	{ 0x02,	0x14,	0x0,	NULL},
+	{ 0x02,	0x20,	0x0,	NULL},
+	{ 0x02,	0x21,	0x0,	NULL},
+	{ 0x02,	0x30,	0x0,	NULL},
+	{ 0x02,	0x31,	0x0,	NULL},
+	{ 0x02,	0x32,	0x0,	NULL},
+	{ 0x02,	0x33,	0x0,	NULL},
+	{ 0x02,	0x34,	0x0,	NULL},
+	{ 0x02,	0x35,	0x0,	NULL},
+	{ 0x02,	0xff,	0x0,	NULL},
+*/
+	/* Sensor/Event netfn (0x04) */
+	{ 0x04,	0x12,	0x80,	"Parameter not supported" },
+	{ 0x04,	0x12,	0x81,	"Attempt to set in progress value" },
+	{ 0x04,	0x12,	0x82,	"Attempt to write read-only parameter" },
+	{ 0x04,	0x13,	0x80,	"Parameter not supported" },
+	{ 0x04,	0x14,	0x81,	"Cannot execute command, SEL in progress" },
+	{ 0x04,	0x15,	0x81,	"Cannot execute command, SEL in progress" },
+	{ 0x04,	0x16,	0x81,	"Alert Immediate rejected due to alert already in progress"},
+	{ 0x04,	0x16,	0x82,	"Alert Immediate rejected due to IPMI messaging session active on this channel"},
+	{ 0x04,	0x21,	0x80,	"Record changed" },
+	/* App netfn (0x06) */
+	{ 0x06,	0x22,	0x80,	"Attempt to start un-initialized watchdog" },
+	{ 0x06,	0x33,	0x80,	"Data not available (queue/buffer) empty" },
+	{ 0x06,	0x34,	0x80,	"Invalid Session Handle" },
+	{ 0x06,	0x34,	0x81,	"Lost Arbitration" },
+	{ 0x06,	0x34,	0x82,	"Bus Error" },
+	{ 0x06,	0x34,	0x83,	"NAK on write" },
+	{ 0x06,	0x35,	0x80,	"Data not available (queue/buffer) empty" },
+	{ 0x06,	0x39,	0x81,	"Invalid user name" },
+	{ 0x06,	0x39,	0x82,	"null user name (User 1) not enabled" },
+	{ 0x06,	0x3a,	0x81,	"No session slot available" },
+	{ 0x06,	0x3a,	0x82,	"No slot available for given user" },
+	{ 0x06,	0x3a,	0x83,	"No slot available to support user due to maximum priv capability" },
+	{ 0x06,	0x3a,	0x84,	"Session sequence number out-of-range" },
+	{ 0x06,	0x3a,	0x85,	"Invalid Session ID in request" },
+	{ 0x06,	0x3a,	0x86,	"Requested maximum privilege level exceeds user and/or channel priv limit" },
+	{ 0x06,	0x3b,	0x80,	"Requested level not available for this user" },
+	{ 0x06,	0x3b,	0x81,	"Requested level exceeds Channel and/or User Privilege limit" },
+	{ 0x06,	0x3b,	0x82,	"Cannot disable User Level authentication" },
+	{ 0x06,	0x3c,	0x81,	"Invalid Session ID in request" },
+	{ 0x06,	0x40,	0x82,	"Set not supported on selected channel" },
+	{ 0x06,	0x40,	0x83,	"Access mode not supported" },
+	{ 0x06,	0x41,	0x82,	"Command not supported for selected channel" },
+	{ 0x06,	0x47,	0x80,	"Password test failed - password mismatch" },
+	{ 0x06,	0x47,	0x81,	"Password test failed - password size error" },
+	{ 0x06,	0x52,	0x81,	"Lost Arbitration" },
+	{ 0x06,	0x52,	0x82,	"Bus Error" },
+	{ 0x06,	0x52,	0x83,	"NAK on write" },
+	{ 0x06,	0x52,	0x84,	"Truncated Read" },
+	/*Storage netfn (0x0a)  */
+	{ 0x0a,	0x11,	0x81,	"FRU device busy" },
+	{ 0x0a,	0x12,	0x80,	"Write-protected offset" },
+	{ 0x0a,	0x12,	0x81,	"FRU device busy" },
+	{ 0x0a,	0x40,	0x81,	"Cannot execute command, SEL erase in progress" },
+	{ 0x0a,	0x42,	0x81,	"Cannot execute command, SEL erase in progress" },
+	{ 0x0a,	0x43,	0x81,	"Cannot execute command, SEL erase in progress" },
+	{ 0x0a,	0x44,	0x80,	"Operation not supported for this Record Type" },
+	{ 0x0a,	0x44,	0x81,	"Cannot execute command, SEL erase in progress" },
+	{ 0x0a,	0x45,	0x80,	"Record rejected due to mismatch between record lenght in header data and number of bytes written" },
+	{ 0x0a,	0x45,	0x81,	"Cannot execute command, SEL erase in progress" },
+	{ 0x0a,	0x46,	0x81,	"Operation not supported for this Record Type" },
+	{ 0x0a,	0x46,	0x81,	"Cannot execute command, SEL erase in progress" },
+	/* PICMG netfn (0x2c) */
+/* Incomplete completion codes
+	{0x2c,	0x00,	0x0,	NULL},
+	{0x2c,	0x01,	0x0,	NULL},
+	{0x2c,	0x02,	0x0,	NULL},
+	{0x2c,	0x03,	0x0,	NULL},
+	{0x2c,	0x04,	0x0,	NULL},
+	{0x2c,	0x05,	0x0,	NULL},
+	{0x2c,	0x06,	0x0,	NULL},
+	{0x2c,	0x07,	0x0,	NULL},
+	{0x2c,	0x08,	0x0,	NULL},
+	{0x2c,	0x09,	0x0,	NULL},
+	{0x2c,	0x0a,	0x0,	NULL},
+	{0x2c,	0x0b,	0x0,	NULL},
+	{0x2c,	0x0c,	0x0,	NULL},
+	{0x2c,	0x0d,	0x0,	NULL},
+	{0x2c,	0x0e,	0x0,	NULL},
+	{0x2c,	0x0f,	0x0,	NULL},
+	{0x2c,	0x10,	0x0,	NULL},
+	{0x2c,	0x11,	0x0,	NULL},
+	{0x2c,	0x12,	0x0,	NULL},
+	{0x2c,	0x13,	0x0,	NULL},
+	{0x2c,	0x14,	0x0,	NULL},
+	{0x2c,	0x15,	0x0,	NULL},
+	{0x2c,	0x16,	0x0,	NULL},
+	{0x2c,	0x17,	0x0,	NULL},
+	{0x2c,	0x18,	0x0,	NULL},
+*/
+};
+
+#define NUM_OF_COMPLCMD_ARRAY (sizeof(ipmi_complcmd_array)/sizeof(ipmi_complcmd_dissect))
+
+
 static const char *
 get_netfn_cmd_text(guint8 netfn, guint8 cmd)
 {
@@ -3970,6 +4100,30 @@ get_netfn_cmd_text(guint8 netfn, guint8 
 	}
 }
 
+/* translate completion codes */
+static const char *
+get_ccode_cmd_text(guint8 netfn, guint8 cmd, guint8 ccode)
+{
+	guint i;
+	/* bit 0 of netfn: even=request odd=response */
+	guint8 netfnr = netfn & 0xFE;
+
+	/* generic completion codes */
+	if (ccode < 0x80 || ccode > 0xBE)
+		return val_to_str(ccode, ipmi_ccode_vals, "Unknown (0x%02x)");
+
+	/* command-specific codes */
+	for (i = 0; i < NUM_OF_COMPLCMD_ARRAY; i++)	{
+		if((netfnr==ipmi_complcmd_array[i].netfn) && (cmd==ipmi_complcmd_array[i].cmd))	{
+			if(ipmi_complcmd_array[i].strptr) {
+				return ipmi_complcmd_array[i].strptr;
+			}
+		}
+	}
+
+	return val_to_str(ccode, ipmi_ccode_vals, "Unknown (0x%02x)");
+}
+
 static void
 dissect_ipmi(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 {
@@ -4052,7 +4206,7 @@ dissect_ipmi(tvbuff_t *tvb, packet_info 
 				col_add_fstr(pinfo->cinfo, COL_INFO, "%s, %s: %s",
 				     get_netfn_cmd_text(netfn, cmd),
 				     val_to_str(netfn, ipmi_netfn_vals,	"Unknown (0x%02x)"),
-				     val_to_str(ccode, ipmi_ccode_vals,	"Unknown (0x%02x)"));
+				     get_ccode_cmd_text(netfn, cmd, ccode));
 			else
 				col_add_fstr(pinfo->cinfo, COL_INFO, "%s, %s",
 				     get_netfn_cmd_text(netfn, cmd),
@@ -4250,8 +4404,9 @@ dissect_ipmi(tvbuff_t *tvb, packet_info 
 
 	/* completion code */
 	if (tree && response) {
-		proto_tree_add_item(ipmi_tree, hf_ipmi_msg_ccode,
-				    tvb, offset++, 1, TRUE);
+		proto_tree_add_text(ipmi_tree, tvb, offset++, 1,
+				    "Completion Code: %s (0x%02x)",
+				    get_ccode_cmd_text(netfn, cmd, ccode), ccode);
 	}