tree 6633683d38b549a75146edafd5dcb91625968d14
parent f85033e8e42fcae9ede8bc9d57c626332f8c3604
author Eunchan Kim <eunchan@opentitan.org> 1582050819 -0800
committer Eunchan Kim <eunchan@opentitan.org> 1582238505 -0800
gpgsig -----BEGIN PGP SIGNATURE-----
 
 iQGzBAABCgAdFiEEuEBfHXBX1JgKhUPPmhfzJJT+XB8FAl5PCyoACgkQmhfzJJT+
 XB9UTQv+IAZcO+Zleucjmr3Y95Z0PBKuTKtaK+ljSAJyL66FauBNDKG0hxwGDIUW
 /M4GiFXwfKd7E79qZe0CibD64lak9Hx3afz9tKbOw2dSLQOA2cIXYnaD6Qoc16Sq
 p54oK5TK0SyzzGl6f76Guo1y7Vdd1WKT5sg33ErTR2C3vZWd1Apj7EkvVoAcvfum
 NMeDTeN0ZXPs/r++NaU1Pe56/FFdAA6pOO0dMigy1xwjXg4FyRQ0mYHKNJu3RNNi
 c23pieOSGphW9iIhJihTMpdWh/bmttEUzQ4iwR10l3R4SDgxe411iXfBJ41v4Ij2
 Kh+TOt2vWyAK8tKVtsbws5rpZ7Dr27aAA7pFaTSyeKCB85VXE/KEEFyKUWOaK+3i
 dTbU0SGCRVggBogZ9XirmCNm8+GUCD1F6cCYQYeEXJpWDn8L+1ScIjm17nGmUnQ/
 1nw8X7mrMfJ2Lvk8dJncE3ZU1g6igHAPMVL0OO9iIs58UJzBBdB+xNEMK1jogt6F
 VCOTi+Ut
 =mqsS
 -----END PGP SIGNATURE-----

[topgen] Use OrderedDict for top, xbar objects

This is related to PR #1552.

Problem:

    In Azure Pipeline that uses Python 3.5, doesn't keep the order of
    hjson keys. It results the generated hjson has a lot of change
    randomly.

`dict` type in python is unordered dictionary. It doesn't maintain the
order of keys in the dictionary. `topgen` dumps a couple of hjson files,
such as generated tops (e.g.
`hw/top_earlgrey_data/autogen/top_earlgrey.gen.hjson`) and the crossbar
configurations (e.g.
`$TOP/ip/xbar_{name}/data/autogen/xbar_{name}.hjson`). This unordered
behavior creates random changes to the generated files, which increases
commit diffs.

From python3.7, the default dictionary type is changed to
`collections.OrderedDict`. So, if the `topgen` runs on the system >=
python3.7, it always maintain the order.

Resolution:

    Use OrderedDict when create dictionary variables.

With OrderedDict (introduced in Python2.7), the generated hjson files
are remains in order.

Signed-off-by: Eunchan Kim <eunchan@opentitan.org>