2 * Routines for dissecting the ATA over Ethernet protocol.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
30 #include <epan/packet.h>
31 #include <epan/emem.h>
32 #include <epan/conversation.h>
36 static int hf_aoe_version=-1;
37 static int hf_aoe_flags_response=-1;
38 static int hf_aoe_flags_error=-1;
39 static int hf_aoe_error=-1;
40 static int hf_aoe_major=-1;
41 static int hf_aoe_minor=-1;
42 static int hf_aoe_cmd=-1;
43 static int hf_aoe_tag=-1;
44 static int hf_aoe_aflags_e=-1;
45 static int hf_aoe_aflags_d=-1;
46 static int hf_aoe_aflags_a=-1;
47 static int hf_aoe_aflags_w=-1;
48 static int hf_aoe_err_feature=-1;
49 static int hf_aoe_sector_count=-1;
50 static int hf_aoe_acmd=-1;
51 static int hf_aoe_astatus=-1;
52 static int hf_aoe_lba=-1;
53 static int hf_aoe_response_in=-1;
54 static int hf_aoe_response_to=-1;
55 static int hf_aoe_time=-1;
57 static gint ett_aoe = -1;
58 static gint ett_aoe_flags = -1;
60 #define AOE_FLAGS_RESPONSE 0x08
61 #define AOE_FLAGS_ERROR 0x04
63 #define AOE_AFLAGS_E 0x40
64 #define AOE_AFLAGS_D 0x10
65 #define AOE_AFLAGS_A 0x02
66 #define AOE_AFLAGS_W 0x01
68 static const true_false_string tfs_aflags_e = {
69 "LBA48 extended command",
72 static const true_false_string tfs_aflags_d = {
76 static const true_false_string tfs_aflags_a = {
80 static const true_false_string tfs_aflags_w = {
81 "WRITE to the device",
85 static const true_false_string tfs_response = {
90 static const true_false_string tfs_error = {
95 static const value_string error_vals[] = {
96 { 1, "Unrecognized command code" },
97 { 2, "Bad argument parameter" },
98 { 3, "Device unavailable" },
99 { 4, "Config string present" },
100 { 5, "Unsupported version" },
104 #define AOE_CMD_ISSUE_ATA_COMMAND 0
105 #define AOE_CMD_QUERY_CONFIG_INFO 1
106 static const value_string cmd_vals[] = {
107 { AOE_CMD_ISSUE_ATA_COMMAND, "Issue ATA Command" },
108 { AOE_CMD_QUERY_CONFIG_INFO, "Query Config Information" },
112 static const value_string ata_cmd_vals[] = {
114 { 0x08, "Atapi soft reset" },
115 { 0x10, "Recalibrate" },
116 { 0x20, "Read sectors (with retry)" },
117 { 0x21, "Read sectors (no retry)" },
118 { 0x22, "Read long (with retry)" },
119 { 0x23, "Read long (no retry)" },
120 { 0x24, "Read ext" },
121 { 0x30, "Write sectors (with retry)" },
122 { 0x31, "Write sectors (no retry)" },
123 { 0x32, "Write long (with retry)" },
124 { 0x33, "Write long (no retry)" },
125 { 0x34, "Write ext" },
126 { 0x3c, "Write verify" },
127 { 0x40, "Read verify sectors (with retry)" },
128 { 0x41, "Read verify sectors (no retry)" },
129 { 0x50, "Format track" },
131 { 0x90, "Execute device diagnostics" },
132 { 0x91, "Initialize device parameters" },
133 { 0x92, "Download microcode" },
134 { 0x94, "Standy immediate" },
135 { 0x95, "Idle immediate" },
138 { 0x98, "Check power mode" },
140 { 0xa0, "Atapi packet" },
141 { 0xa1, "Atapi identify device" },
142 { 0xa2, "Atapi service" },
144 { 0xc4, "Read multiple" },
145 { 0xc5, "Write multiple" },
146 { 0xc6, "Set multiple mode" },
147 { 0xc8, "Read dma (with retry)" },
148 { 0xc9, "Read dma (no retry)" },
149 { 0xca, "Write dma (with retry)" },
150 { 0xcb, "Write dma (no retry)" },
151 { 0xde, "Door lock" },
152 { 0xdf, "Door unlock" },
153 { 0xe0, "Standy immediate" },
154 { 0xe1, "Idle immediate" },
157 { 0xe4, "Read buffer" },
158 { 0xe5, "Check power mode" },
160 { 0xe8, "Write buffer" },
161 { 0xec, "Identify Device" },
162 { 0xed, "Media eject" },
163 { 0xee, "Identify device dma" },
164 { 0xef, "Set features" },
165 { 0xf1, "Security set password" },
166 { 0xf2, "Security unlock" },
167 { 0xf3, "Security erase prepare" },
168 { 0xf4, "Security erase unit" },
169 { 0xf5, "Security freeze" },
170 { 0xf6, "Security disable password" },
174 typedef struct ata_info_t {
176 void *conversation; /* just used to multiplex different conversations */
177 guint32 request_frame;
178 guint32 response_frame;
182 static GHashTable *ata_cmd_unmatched = NULL;
183 static GHashTable *ata_cmd_matched = NULL;
186 ata_cmd_hash_matched(gconstpointer k)
188 return GPOINTER_TO_UINT(k);
192 ata_cmd_equal_matched(gconstpointer k1, gconstpointer k2)
198 ata_cmd_hash_unmatched(gconstpointer k)
200 const ata_info_t *key = k;
206 ata_cmd_equal_unmatched(gconstpointer k1, gconstpointer k2)
208 const ata_info_t *key1 = k1;
209 const ata_info_t *key2 = k2;
211 return (key1->tag==key2->tag)&&(key1->conversation==key2->conversation);
215 dissect_ata_pdu(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, gboolean response, guint32 tag)
217 proto_item *tmp_item;
220 ata_info_t *ata_info=NULL;
221 conversation_t *conversation;
223 /* only create a conversation for ATA commands */
224 conversation = find_conversation(pinfo->fd->num, &pinfo->src, &pinfo->dst,
225 pinfo->ptype, pinfo->srcport,
227 if (conversation == NULL) {
228 /* We don't yet have a conversation, so create one. */
229 conversation = conversation_new(pinfo->fd->num, &pinfo->src, &pinfo->dst,
230 pinfo->ptype, pinfo->srcport,
234 if( !(pinfo->fd->flags.visited) ){
236 ata_info_t *tmp_ata_info;
237 /* first time we see this request so add a struct for request/response
239 ata_info=se_alloc(sizeof(ata_info_t));
241 ata_info->conversation=conversation;
242 ata_info->request_frame=pinfo->fd->num;
243 ata_info->response_frame=0;
244 ata_info->cmd=tvb_get_guint8(tvb, offset+3);
245 ata_info->req_time=pinfo->fd->abs_ts;
247 tmp_ata_info=g_hash_table_lookup(ata_cmd_unmatched, ata_info);
249 g_hash_table_remove(ata_cmd_unmatched, tmp_ata_info);
251 g_hash_table_insert(ata_cmd_unmatched, ata_info, ata_info);
253 ata_info_t tmp_ata_info;
254 /* first time we see this response so see if we can match it with
256 tmp_ata_info.tag=tag;
257 tmp_ata_info.conversation=conversation;
258 ata_info=g_hash_table_lookup(ata_cmd_unmatched, &tmp_ata_info);
259 /* woo hoo we could, so no need to store this in unmatched any more,
260 move both request and response to the matched table */
262 ata_info->response_frame=pinfo->fd->num;
263 g_hash_table_remove(ata_cmd_unmatched, ata_info);
264 g_hash_table_insert(ata_cmd_matched, GUINT_TO_POINTER(ata_info->request_frame), ata_info);
265 g_hash_table_insert(ata_cmd_matched, GUINT_TO_POINTER(ata_info->response_frame), ata_info);
269 ata_info=g_hash_table_lookup(ata_cmd_matched, GUINT_TO_POINTER(pinfo->fd->num));
274 if(ata_info->request_frame){
276 tmp_item=proto_tree_add_uint(tree, hf_aoe_response_to, tvb, 0, 0, ata_info->request_frame);
277 PROTO_ITEM_SET_GENERATED(tmp_item);
278 nstime_delta(&delta_ts, &pinfo->fd->abs_ts, &ata_info->req_time);
279 tmp_item=proto_tree_add_time(tree, hf_aoe_time, tvb, offset, 0, &delta_ts);
280 PROTO_ITEM_SET_GENERATED(tmp_item);
283 if(ata_info->response_frame){
284 tmp_item=proto_tree_add_uint(tree, hf_aoe_response_in, tvb, 0, 0, ata_info->response_frame);
285 PROTO_ITEM_SET_GENERATED(tmp_item);
291 aflags=tvb_get_guint8(tvb, offset);
292 proto_tree_add_item(tree, hf_aoe_aflags_e, tvb, offset, 1, FALSE);
293 if(aflags&AOE_AFLAGS_E){
294 proto_tree_add_item(tree, hf_aoe_aflags_d, tvb, offset, 1, FALSE);
296 if(aflags&AOE_AFLAGS_W){
297 proto_tree_add_item(tree, hf_aoe_aflags_a, tvb, offset, 1, FALSE);
299 proto_tree_add_item(tree, hf_aoe_aflags_w, tvb, offset, 1, FALSE);
303 proto_tree_add_item(tree, hf_aoe_err_feature, tvb, offset, 1, FALSE);
307 proto_tree_add_item(tree, hf_aoe_sector_count, tvb, offset, 1, FALSE);
310 /* ata command/status */
312 proto_tree_add_item(tree, hf_aoe_acmd, tvb, offset, 1, FALSE);
313 if (check_col(pinfo->cinfo, COL_INFO)) {
314 col_append_fstr(pinfo->cinfo, COL_INFO, " ATA:%s", val_to_str(tvb_get_guint8(tvb, offset), ata_cmd_vals, " Unknown ATA<0x%02x>"));
317 proto_tree_add_item(tree, hf_aoe_astatus, tvb, offset, 1, FALSE);
318 if(ata_info && ata_info->request_frame){
319 /* we dont know what command it was unless we saw the request_frame */
320 tmp_item=proto_tree_add_uint(tree, hf_aoe_acmd, tvb, 0, 0, ata_info->cmd);
321 PROTO_ITEM_SET_GENERATED(tmp_item);
322 if (check_col(pinfo->cinfo, COL_INFO)) {
323 col_append_fstr(pinfo->cinfo, COL_INFO, " ATA:%s", val_to_str(ata_info->cmd, ata_cmd_vals, " Unknown ATA<0x%02x>"));
329 /*lba probably complete wrong */
330 lba=tvb_get_letohs(tvb, offset+4);
331 lba=(lba<<32)|tvb_get_letohl(tvb, offset);
333 proto_tree_add_uint64(tree, hf_aoe_lba, tvb, offset-8, 6, lba);
338 dissect_aoe_v1(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
342 proto_item *flags_item=NULL;
343 proto_tree *flags_tree=NULL;
345 /* read and dissect the flags */
346 flags=tvb_get_guint8(tvb, 0)&0x0f;
348 flags_item=proto_tree_add_text(tree, tvb, 0, 1, "Flags:");
349 flags_tree=proto_item_add_subtree(flags_item, ett_aoe_flags);
351 proto_tree_add_item(flags_tree, hf_aoe_flags_response, tvb, 0, 1, FALSE);
352 proto_tree_add_item(flags_tree, hf_aoe_flags_error, tvb, 0, 1, FALSE);
354 proto_item_append_text(flags_item,(flags&AOE_FLAGS_RESPONSE)?" Response":" Request");
355 if(flags&AOE_FLAGS_ERROR){
356 proto_item_append_text(flags_item, " Error");
362 if(flags&AOE_FLAGS_ERROR){
363 proto_tree_add_item(tree, hf_aoe_error, tvb, 1, 1, FALSE);
364 if (check_col(pinfo->cinfo, COL_INFO)) {
365 col_append_fstr(pinfo->cinfo, COL_INFO, "Error:%s ", val_to_str(tvb_get_guint8(tvb, 1), error_vals, "Unknown error<%d>"));
369 /* major/minor address */
370 proto_tree_add_item(tree, hf_aoe_major, tvb, 2, 2, FALSE);
371 proto_tree_add_item(tree, hf_aoe_minor, tvb, 4, 1, FALSE);
374 cmd=tvb_get_guint8(tvb, 5);
375 proto_tree_add_item(tree, hf_aoe_cmd, tvb, 5, 1, FALSE);
376 if (check_col(pinfo->cinfo, COL_INFO)) {
377 col_append_fstr(pinfo->cinfo, COL_INFO, "%s %s", val_to_str(cmd, cmd_vals, "Unknown command<%d>"), (flags&AOE_FLAGS_RESPONSE)?"Response":"Request");
381 tag=tvb_get_letohl(tvb, 6);
382 proto_tree_add_item(tree, hf_aoe_tag, tvb, 6, 4, FALSE);
386 case AOE_CMD_ISSUE_ATA_COMMAND:
387 dissect_ata_pdu(pinfo, tree, tvb, 10, flags&AOE_FLAGS_RESPONSE, tag);
389 case AOE_CMD_QUERY_CONFIG_INFO:
396 dissect_aoe(tvbuff_t *tvb, packet_info *pinfo, proto_tree *parent_tree)
398 proto_item *item=NULL;
399 proto_tree *tree=NULL;
402 if (check_col(pinfo->cinfo, COL_PROTOCOL))
403 col_set_str(pinfo->cinfo, COL_PROTOCOL, "AoE");
404 if (check_col(pinfo->cinfo, COL_INFO))
405 col_clear(pinfo->cinfo, COL_INFO);
408 item = proto_tree_add_item(parent_tree, proto_aoe, tvb, 0, -1, FALSE);
409 tree = proto_item_add_subtree(item, ett_aoe);
412 version=tvb_get_guint8(tvb, 0)>>4;
413 proto_tree_add_uint(tree, hf_aoe_version, tvb, 0, 1, version);
416 dissect_aoe_v1(tvb, pinfo, tree);
424 if(ata_cmd_unmatched){
425 g_hash_table_destroy(ata_cmd_unmatched);
426 ata_cmd_unmatched=NULL;
428 ata_cmd_unmatched=g_hash_table_new(ata_cmd_hash_unmatched, ata_cmd_equal_unmatched);
431 g_hash_table_destroy(ata_cmd_matched);
432 ata_cmd_matched=NULL;
434 ata_cmd_matched=g_hash_table_new(ata_cmd_hash_matched, ata_cmd_equal_matched);
439 proto_register_aoe(void)
442 static hf_register_info hf[] = {
444 { "Command", "aoe.cmd", FT_UINT8, BASE_DEC, VALS(cmd_vals), 0x0,
445 "AOE Command", HFILL}},
447 { "Version", "aoe.version", FT_UINT8, BASE_DEC, NULL, 0x0,
448 "Version of the AOE protocol", HFILL}},
450 { "Error", "aoe.error", FT_UINT8, BASE_DEC, VALS(error_vals), 0x0,
451 "Error code", HFILL}},
452 { &hf_aoe_err_feature,
453 { "Err/Feature", "aoe.err_feature", FT_UINT8, BASE_HEX, NULL, 0x0,
454 "Err/Feature", HFILL}},
455 { &hf_aoe_sector_count,
456 { "Sector Count", "aoe.sector_count", FT_UINT8, BASE_DEC, NULL, 0x0,
457 "Sector Count", HFILL}},
458 { &hf_aoe_flags_response,
459 { "Response flag", "aoe.response", FT_BOOLEAN, 8, TFS(&tfs_response), AOE_FLAGS_RESPONSE, "Whether this is a response PDU or not", HFILL}},
460 { &hf_aoe_flags_error,
461 { "Error flag", "aoe.error", FT_BOOLEAN, 8, TFS(&tfs_error), AOE_FLAGS_ERROR, "Whether this is an error PDU or not", HFILL}},
463 { "Major", "aoe.major", FT_UINT16, BASE_HEX, NULL, 0x0,
464 "Major address", HFILL}},
466 { "Minor", "aoe.minor", FT_UINT8, BASE_HEX, NULL, 0x0,
467 "Minor address", HFILL}},
469 { "ATA Cmd", "aoe.ata.cmd", FT_UINT8, BASE_HEX, VALS(ata_cmd_vals), 0x0,
470 "ATA command opcode", HFILL}},
472 { "ATA Status", "aoe.ata.status", FT_UINT8, BASE_HEX, NULL, 0x0,
473 "ATA status bits", HFILL}},
475 { "Tag", "aoe.tag", FT_UINT32, BASE_HEX, NULL, 0x0,
476 "Command Tag", HFILL}},
478 { "E", "aoe.aflags.e", FT_BOOLEAN, 8, TFS(&tfs_aflags_e), AOE_AFLAGS_E, "Whether this is a normal or LBA48 command", HFILL}},
480 { "D", "aoe.aflags.d", FT_BOOLEAN, 8, TFS(&tfs_aflags_d), AOE_AFLAGS_D, "", HFILL}},
482 { "A", "aoe.aflags.a", FT_BOOLEAN, 8, TFS(&tfs_aflags_a), AOE_AFLAGS_A, "Whether this is an asynchronous write or not", HFILL}},
484 { "W", "aoe.aflags.w", FT_BOOLEAN, 8, TFS(&tfs_aflags_w), AOE_AFLAGS_W, "Is this a command writing data to the device or not", HFILL}},
486 { "Lba", "aoe.lba", FT_UINT64, BASE_HEX, NULL, 0x00, "Lba address", HFILL}},
487 { &hf_aoe_response_in,
488 { "Response In", "aoe.response_in", FT_FRAMENUM, BASE_DEC, NULL, 0x0, "The response to this packet is in this frame", HFILL }},
489 { &hf_aoe_response_to,
490 { "Response To", "aoe.response_to", FT_FRAMENUM, BASE_DEC, NULL, 0x0, "This is a response to the ATA command in this frame", HFILL }},
492 { "Time from request", "aoe.time", FT_RELATIVE_TIME, BASE_NONE, NULL, 0, "Time between Request and Reply for ATA calls", HFILL }},
495 static gint *ett[] = {
500 proto_aoe = proto_register_protocol("ATAoverEthernet", "AOE", "aoe");
501 proto_register_field_array(proto_aoe, hf, array_length(hf));
502 proto_register_subtree_array(ett, array_length(ett));
504 register_dissector("aoe", dissect_aoe, proto_aoe);
505 register_init_routine(ata_init);
509 proto_reg_handoff_aoe(void)
511 dissector_handle_t aoe_handle;
513 aoe_handle = find_dissector("aoe");
514 dissector_add("ethertype", ETHERTYPE_AOE, aoe_handle);