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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2012 by Amaury Pouly
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef __SOC_DESC__
#define __SOC_DESC__
#include <stdint.h>
#include <vector>
#include <list>
#include <string>
/**
* These data structures represent the SoC register in a convenient way.
* The basic structure is the following:
* - each SoC has several devices
* - each device has a generic name, a list of {name,address} and several registers
* - each register has a generic name, a list of {name,address}, flags,
* several fields
* - each field has a name, a first and last bit position, can apply either
* to all addresses of a register or be specific to one only and has several values
* - each field value has a name and a value
*
* All addresses, values and names are relative to the parents. For example a field
* value BV_LCDIF_CTRL_WORD_LENGTH_18_BIT is represented has:
* - device LCDIF, register CTRL, field WORD_LENGTH, value 16_BIT
* The address of CTRL is related to the address of LCDIF, the value of 16_BIT
* ignores the position of the WORD_LENGTH field in the register.
*/
/**
* Typedef for SoC types: word, address and flags */
typedef uint32_t soc_addr_t;
typedef uint32_t soc_word_t;
typedef uint32_t soc_reg_flags_t;
/** SoC register generic formula */
enum soc_reg_formula_type_t
{
REG_FORMULA_NONE, /// register has no generic formula
REG_FORMULA_STRING, /// register has a generic formula represented by a string
};
/** <soc_reg_t>.<flags> values */
const soc_reg_flags_t REG_HAS_SCT = 1 << 0; /// register SCT variants
/** SoC register field named value */
struct soc_reg_field_value_t
{
std::string name; /// name of the value
soc_word_t value; /// numeric value
std::string desc; /// human description
};
/** SoC register field */
struct soc_reg_field_t
{
std::string name; /// name of the field
std::string desc; /// human description
unsigned first_bit, last_bit; /// bit range of the field
soc_word_t bitmask() const
{
// WARNING beware of the case where first_bit=0 and last_bit=31
if(first_bit == 0 && last_bit == 31)
return 0xffffffff;
else
return ((1 << (last_bit - first_bit + 1)) - 1) << first_bit;
}
bool is_reserved() const
{
return name.substr(0, 4) == "RSVD" || name.substr(0, 5) == "RSRVD";
}
std::vector< soc_reg_field_value_t > value;
};
/** SoC register address */
struct soc_reg_addr_t
{
std::string name; /// actual register name
soc_addr_t addr; /// actual register address (relative to device)
};
/** SoC register formula */
struct soc_reg_formula_t
{
enum soc_reg_formula_type_t type;
std::string string; /// for STRING
};
/** SoC register */
struct soc_reg_t
{
std::string name; /// generic name (for multi registers) or actual name
std::string desc; /// human description
std::vector< soc_reg_addr_t > addr; /// instances of the registers
soc_reg_formula_t formula; /// formula for the instance addresses
soc_reg_flags_t flags; /// ORed value
std::vector< soc_reg_field_t > field;
};
/** Soc device address */
struct soc_dev_addr_t
{
std::string name; /// actual device name
soc_addr_t addr;
};
/** SoC device */
struct soc_dev_t
{
std::string name; /// generic name (of multi devices) or actual name
std::string long_name; /// human friendly name
std::string desc; /// human description
std::string version; /// description version
std::vector< soc_dev_addr_t > addr;
std::vector< soc_reg_t > reg;
};
/** SoC */
struct soc_t
{
std::string name; /// codename (rockbox)
std::string desc; /// SoC name
std::vector< soc_dev_t > dev;
};
/** Parse a SoC description from a XML file, append it to <soc>. A file
* can contain multiple SoC descriptions */
bool soc_desc_parse_xml(const std::string& filename, std::vector< soc_t >& soc);
#endif /* __SOC_DESC__ */
|
