Skip to contentSkip to conversation

DTC - validation by device_type

PATCH In review Paul Nasrat 4 participants 7 messages Mar 28, 2006 – Apr 24, 2006

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 DTC - validation by device_type

Jon,

It'd be nice to be able to validate by device_type, to ensure that we don't reinvent the wheel (address vs. local-mac-address) and to give embedded designers an added level of sanity checking.

Here is a proposed implementation with an implemented check for "network".

livetree.c +47 -0
index ef54174..351773b 100644
@@ -441,6 +441,52 @@ static int check_structure(struct node *
 				(propname), (node)->fullpath); \
 	} while (0)
 
+static int check_network(struct node *net)
+{
+
+	int ok = 1;
+	struct property *prop;
+
+	CHECK_HAVE_STREQ(net, "device_type", "network");
+	CHECK_HAVE(net, "reg");
+	CHECK_HAVE(net, "local-mac-address");
+	CHECK_HAVE(net, "mac-address");
+	CHECK_HAVE(net, "address-bits");
+
+	return ok;
+}
+
+static struct {
+	char *devtype;
+	int (*check_fn)(struct node *node);
+} devtype_checker_table[] = {
+	{"network", check_network},
+};
+
+static int check_devtypes(struct node *root)
+{
+
+	struct node *child;
+	struct property *prop;
+	int ok = 1;
+	int i;
+
+	for_each_child(root, child) {
+		/* check this node */
+		if ((prop = get_property((child), ("device_type"))))
+			for (i = 0; i < ARRAY_SIZE(devtype_checker_table); i++) {
+				if (streq(prop->val.val, devtype_checker_table[i].devtype))
+					if (! devtype_checker_table[i].check_fn(child)) {
+						ok = 0;
+						break;
+						}
+			}
+		ok = check_devtypes(child);
+	}
+
+	return ok;
+}
+
 static int check_root(struct node *root)
 {
 	struct property *prop;
@@ -716,6 +762,7 @@ int check_device_tree(struct node *dt)
 	ok = ok && check_cpus(dt);
 	ok = ok && check_memory(dt);
 	ok = ok && check_chosen(dt);
+	ok = ok && check_devtypes(dt);
 	if (! ok)
 		return 0;
 
#1 lore raw
Quoted 15 lines · Paul Nasrat

It'd be nice to be able to validate by device_type, to ensure that we don't reinvent the wheel (address vs. local-mac-address) and to give embedded designers an added level of sanity checking.

Here is a proposed implementation with an implemented check for "network".

livetree.c +0 -0
index ef54174..351773b 100644

livetree.c static int check_structure(struct node * · line 450

Quoted 10 lines
livetree.c +7 -0
@@ -441,6 +441,52 @@ static int check_structure(struct node *
 				(propname), (node)->fullpath); \
 	} while (0)
 
+static int check_network(struct node *net)
+{
+
+	int ok = 1;
+	struct property *prop;
+
+	CHECK_HAVE_STREQ(net, "device_type", "network");

The only reason you got into this function was that device_type == "network"...

Quoted 22 lines
livetree.c +22 -0
+	CHECK_HAVE(net, "reg");
+	CHECK_HAVE(net, "local-mac-address");
+	CHECK_HAVE(net, "mac-address");
+	CHECK_HAVE(net, "address-bits");
+
+	return ok;
+}
+
+static struct {
+	char *devtype;
+	int (*check_fn)(struct node *node);
+} devtype_checker_table[] = {
+	{"network", check_network},
+};
+
+static int check_devtypes(struct node *root)
+{
+
+	struct node *child;
+	struct property *prop;
+	int ok = 1;
+	int i;

livetree.c static int check_structure(struct node * · line 482

Quoted 10 lines
livetree.c +10 -0
+
+	for_each_child(root, child) {
+		/* check this node */
+		if ((prop = get_property((child), ("device_type"))))
+			for (i = 0; i < ARRAY_SIZE(devtype_checker_table); i++) {
+				if (streq(prop->val.val, devtype_checker_table[i].devtype))
+					if (! devtype_checker_table[i].check_fn(child)) {
+						ok = 0;
+						break;
+						}

Unless this is some weird style thing, that close brace seems misindented.

Quoted 24 lines
livetree.c +8 -0
+			}
+		ok = check_devtypes(child);
+	}
+
+	return ok;
+}
+
 static int check_root(struct node *root)
 {
 	struct property *prop;
@@ -716,6 +762,7 @@ int check_device_tree(struct node *dt)
 	ok = ok && check_cpus(dt);
 	ok = ok && check_memory(dt);
 	ok = ok && check_chosen(dt);
+	ok = ok && check_devtypes(dt);
 	if (! ok)
 		return 0;
 

_______________________________________________
Linuxppc-dev mailing list
[email protected]
https://ozlabs.org/mailman/listinfo/linuxppc-dev

#2 lore raw
Quoted 6 lines · Hollis Blanchard
Quoted 5 lines · Paul Nasrat

It'd be nice to be able to validate by device_type, to ensure that we don't reinvent the wheel (address vs. local-mac-address) and to give embedded designers an added level of sanity checking.

Quoted 6 lines
Quoted 4 lines

Here is a proposed implementation with an implemented check for "network".

Unless this is some weird style thing, that close brace seems misindented.

No you're not missing anything, both artefacts of how I got there. Take 2.

As above

livetree.c +46 -0
index ef54174..bf8bb56 100644
@@ -441,6 +441,51 @@ static int check_structure(struct node *
 				(propname), (node)->fullpath); \
 	} while (0)
 
+static int check_network(struct node *net)
+{
+
+	int ok = 1;
+	struct property *prop;
+
+	CHECK_HAVE(net, "reg");
+	CHECK_HAVE(net, "local-mac-address");
+	CHECK_HAVE(net, "mac-address");
+	CHECK_HAVE(net, "address-bits");
+
+	return ok;
+}
+
+static struct {
+	char *devtype;
+	int (*check_fn)(struct node *node);
+} devtype_checker_table[] = {
+	{"network", check_network},
+};
+
+static int check_devtypes(struct node *root)
+{
+
+	struct node *child;
+	struct property *prop;
+	int ok = 1;
+	int i;
+
+	for_each_child(root, child) {
+		/* check this node */
+		if ((prop = get_property((child), ("device_type"))))
+			for (i = 0; i < ARRAY_SIZE(devtype_checker_table); i++) {
+				if (streq(prop->val.val, devtype_checker_table[i].devtype))
+					if (! devtype_checker_table[i].check_fn(child)) {
+						ok = 0;
+						break;
+					}
+			}
+		ok = check_devtypes(child);
+	}
+
+	return ok;
+}
+
 static int check_root(struct node *root)
 {
 	struct property *prop;
@@ -716,6 +761,7 @@ int check_device_tree(struct node *dt)
 	ok = ok && check_cpus(dt);
 	ok = ok && check_memory(dt);
 	ok = ok && check_chosen(dt);
+	ok = ok && check_devtypes(dt);
 	if (! ok)
 		return 0;
 
#3 lore raw
Quoted 1 line · Paul Nasrat

Paul,

Sorry about the hang-time here. Couple questions.

livetree.c static int check_structure(struct node * · line 456

Quoted 13 lines
livetree.c +13 -0
+static int check_network(struct node *net)
+{
+
+	int ok = 1;
+	struct property *prop;
+
+	CHECK_HAVE(net, "reg");
+	CHECK_HAVE(net, "local-mac-address");
+	CHECK_HAVE(net, "mac-address");
+	CHECK_HAVE(net, "address-bits");
+
+	return ok;
+}

This says that all network nodes have to have all four of those properties. It's not clear to me that they all need to have both local-mac-address and mac-address. Specifically, 1275 seems to indicate to me that the mac-address property, being introduced by the open operation, might be dynamically set at run time, rather than passed as a config parameter from, say, U-Boot to the kernel. Thus, it might not be necessary here.

Should this check be more like "has at least one of local-mac-address and mac-address" instead?

Quoted 35 lines
livetree.c +31 -0
+static struct {
+	char *devtype;
+	int (*check_fn)(struct node *node);
+} devtype_checker_table[] = {
+	{"network", check_network},
+};
+
+static int check_devtypes(struct node *root)
+{
+
+	struct node *child;
+	struct property *prop;
+	int ok = 1;
+	int i;
+
+	for_each_child(root, child) {
+		/* check this node */
+		if ((prop = get_property((child), ("device_type"))))
+			for (i = 0; i < ARRAY_SIZE(devtype_checker_table); i++) {
+				if (streq(prop->val.val, devtype_checker_table[i].devtype))
+					if (! devtype_checker_table[i].check_fn(child)) {
+						ok = 0;
+						break;
+					}
+			}
+		ok = check_devtypes(child);
+	}
+
+	return ok;
+}
+
 static int check_root(struct node *root)
 {
 	struct property *prop;

livetree.c int check_device_tree(struct node *dt) · line 766

Quoted 6 lines
livetree.c +1 -0
@@ -716,6 +761,7 @@ int check_device_tree(struct node *dt)
 	ok = ok && check_cpus(dt);
 	ok = ok && check_memory(dt);
 	ok = ok && check_chosen(dt);
+	ok = ok && check_devtypes(dt);
 	if (! ok)
 		return 0;

I buy the rest of this.

Thanks,
jdl

#4 lore raw
Quoted 28 lines · Jon Loeliger
Quoted 1 line · Paul Nasrat

Paul,

Sorry about the hang-time here. Couple questions.

livetree.c static int check_structure(struct node * · line 456

Quoted 13 lines
livetree.c +13 -0
+static int check_network(struct node *net)
+{
+
+	int ok = 1;
+	struct property *prop;
+
+	CHECK_HAVE(net, "reg");
+	CHECK_HAVE(net, "local-mac-address");
+	CHECK_HAVE(net, "mac-address");
+	CHECK_HAVE(net, "address-bits");
+
+	return ok;
+}

This says that all network nodes have to have all four of those properties. It's not clear to me that they all need to have both local-mac-address and mac-address.

Quoted 5 lines

Specifically, 1275 seems to indicate to me that the mac-address property, being introduced by the open operation, might be dynamically set at run time, rather than passed as a config parameter from, say, U-Boot to the kernel. Thus, it might not be necessary here.

1275 defines shall to indicate a mandatory requirement.

p.165 (Annexe A) defines "network" device_type:

A standard package with this "device_type" property shall implement the following methods:

open, ...

Requirements for open method:

Execute mac-address and create a "mac-address" property with that value.
...
A standard package with this "device_type" property shall implement the following property if the associated device has a preassigned IEEE 802.3 MAC (network) address:

So for flattened device tree my reading would be something like:

local-mac-address - for the most part this would be compulsory - does anyone have any cases where a device would not have a preassigned MAC address? Use of address in the booting-without-of and example should be replaced by local-mac-address.

For a standard 1275 tree mac-address would be created on open, obviously this isn't a hard requirement for compatibility so I think we could make this optional.

Paul

#5 lore raw
Quoted 4 lines
Quoted 4 lines

livetree.c static int check_structure(struct node * · line 453

Quoted 4 lines
livetree.c +4 -0
+	CHECK_HAVE(net, "reg");
+	CHECK_HAVE(net, "local-mac-address");
+	CHECK_HAVE(net, "mac-address");
+	CHECK_HAVE(net, "address-bits");

1) It's hard to see how any (physical) network device would not have a "reg" property. It is not required though.

2) "local-mac-address" is not a required property.

3) "mac-address" is only required for nodes that have been opened before.

4) "address-bits" is not required (taken as 48 if absent).

Please see Annex A (look at the property names, and perhaps at the "network" device type). _Always_ look at Annex A! It's normative.

Segher

#6 lore raw
Quoted 5 lines · Segher Boessenkool

1) It's hard to see how any (physical) network device would not have a "reg" property. It is not required though.

2) "local-mac-address" is not a required property.

Quoted 8 lines

3) "mac-address" is only required for nodes that have been opened before.

4) "address-bits" is not required (taken as 48 if absent).

Please see Annex A (look at the property names, and perhaps at the "network" device type). _Always_ look at Annex A! It's normative.

My bad. Jon, just drop this from your queue then.

Paul