realtek-registers/dump_database.py at master · svanheule/realtek-registers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
#!/usr/bin/env python3
import argparse
import csv
import os

from realtek_reglist import app
from realtek_reglist.models import db
from realtek_reglist.models.auth import User
from realtek_reglist.models.description import DescriptionRevision
from realtek_reglist.models.soc import Family, Feature, Register, Field, Table, TableField

def model_table_name(model):
    if hasattr(model, '__tablename__'):
        return model.__tablename__
    else:
        raise ValueError('Unsupported object')

def dump_table(directory, model, query, tablename=None):
    if tablename is None:
        tablename = model_table_name(model)
    filename = f'{tablename}.csv'
    if directory is not None:
        filename = os.path.join(directory, filename)
    print(f'Dumping {filename}...')
    with open(filename, 'w') as csvfile:
        writer = csv.writer(csvfile, quoting=csv.QUOTE_MINIMAL)
        for result in query.all():
            writer.writerow(result)


if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Dump Realtek switch SoC description database to CSV files')
    parser.add_argument('-o', '--output-directory', default='', help='Output directory for the CSV files')
    args = parser.parse_args()

    with app.app_context():
        out_dir = os.path.abspath(args.output_directory)

        if not os.path.exists(out_dir):
            os.mkdir(out_dir, 0o775)
        elif not os.path.isdir(out_dir):
            raise ValueError(f'{out_dir} is not a directory')

        dump_table(out_dir,
                User,
                db.session.query(User.username)
        )
        dump_table(out_dir,
                Family,
                db.session.query(Family.id, Family.name)
        )
        dump_table(out_dir,
                Feature,
                db.session.query(Family.name, Feature.name).join(Feature.family)
        )
        dump_table(out_dir,
                Register,
                db.session.query(Family.name, Feature.name, Register.name,
                    Register.offset, Register.port_idx_min, Register.port_idx_max,
                    Register.array_idx_min, Register.array_idx_max,
                    Register.portlist_idx, Register.bit_offset)\
                        .join(Register.family)\
                        .join(Register.feature)
        )
        dump_table(out_dir,
                Field,
                db.session.query(Family.name, Register.name, Field.name,
                        Field.lsb, Field.size)\
                        .join(Field.register)\
                        .join(Register.family)

        )
        CtrlReg = db.aliased(Register)
        DataReg = db.aliased(Register)
        dump_table(out_dir,
                Table,
                db.session.query(Family.name, Feature.name, Table.name,
                    Table.access_type, Table.size,
                    CtrlReg.name, DataReg.name)\
                        .join(Table.family)\
                        .join(Table.feature)\
                        .join(CtrlReg, Table.ctrl_register)\
                        .join(DataReg, Table.data_register)
        )
        dump_table(out_dir,
                TableField,
                db.session.query(Family.name, Table.name, TableField.name, TableField.lsb, TableField.size)\
                        .join(TableField.table)\
                        .join(Table.family)
        )
        dump_table(out_dir,
                Register,
                db.session.query(
                    Family.name, Register.name, User.username,
                    DescriptionRevision.timestamp, DescriptionRevision.value)\
                        .join(Register.family)\
                        .join(Register.description_revisions)\
                        .join(DescriptionRevision.author),
                tablename='description_register'
        )
        dump_table(out_dir,
                Field,
                db.session.query(
                    Family.name, Register.name, Field.lsb, User.username,
                    DescriptionRevision.timestamp, DescriptionRevision.value)\
                        .join(Field.register)\
                        .join(Register.family)\
                        .join(Field.description_revisions)\
                        .join(DescriptionRevision.author),
                tablename='description_registerfield'
        )
        dump_table(out_dir,
                Table,
                db.session.query(
                    Family.name, Table.name, User.username,
                    DescriptionRevision.timestamp, DescriptionRevision.value)\
                        .join(Table.family)\
                        .join(Table.description_revisions)\
                        .join(DescriptionRevision.author),
                tablename='description_table'
        )
        dump_table(out_dir,
                TableField,
                db.session.query(
                    Family.name, Table.name, TableField.lsb, User.username,
                    DescriptionRevision.timestamp, DescriptionRevision.value)\
                        .join(TableField.table)\
                        .join(Table.family)\
                        .join(TableField.description_revisions)\
                        .join(DescriptionRevision.author),
                tablename='description_tablefield'
        )