source: atk2-sc3-1.4.0-ntisr/utils/abrex/readme.txt@ 172

Last change on this file since 172 was 172, checked in by ertl-ishikawa, 8 years ago

ATK2-SC3 1.4.0 RH850依存部 非信頼C2ISR対応を追加

File size: 12.1 KB
Line 
1
2 ABREX - AUTOSAR BSW and RTE XML Generator -
3
4本ドキュメントは,ABREXを使用するために必
5要な事項
6を説明するものである.
7
8----------------------------------------------------------------------
9ABREX
10 AUTOSAR BSW and RTE XML Generator
11
12Copyright (C) 2013-2015 by Center for Embedded Computing Systems
13 Graduate School of Information Science, Nagoya Univ., JAPAN
14Copyright (C) 2014-2015 by AISIN COMCRUISE Co., Ltd., JAPAN
15Copyright (C) 2013-2015 by FUJI SOFT INCORPORATED, JAPAN
16Copyright (C) 2014-2015 by NEC Communication Systems, Ltd., JAPAN
17Copyright (C) 2013-2015 by Panasonic Advanced Technology Development Co., Ltd., JAPAN
18Copyright (C) 2013-2014 by Renesas Electronics Corporation, JAPAN
19Copyright (C) 2014-2015 by SCSK Corporation, JAPAN
20Copyright (C) 2013-2015 by Sunny Giken Inc., JAPAN
21Copyright (C) 2013-2015 by TOSHIBA CORPORATION, JAPAN
22Copyright (C) 2013-2015 by Witz Corporation
23Copyright (C) 2015 by SUZUKI MOTOR CORPORATION
24
25上記著作権者
26は,以下の (1)〜(3)の条件を満たす場合に限り,本ドキュメ
27ント(本ドキュメントを改変したものを含む.以下同じ)を使用・複製・改
28変・再é…
29å¸ƒï¼ˆä»¥ä¸‹ï¼Œåˆ©ç”¨ã¨å‘¼ã¶ï¼‰ã™ã‚‹ã“とを無償で許諾する.
30(1) 本ドキュメントを利用する場合には,上記の著作権表示,この利用条件
31 および下記の無保証規定が,そのままの形でドキュメント中に含まれて
32 いること.
33(2) 本ドキュメントを改変する場合には,ドキュメントを改変した旨の記述
34 を,改変後のドキュメント中に含めること.ただし,改変後のドキュメ
35 ントが,TOPPERSプロジェクト指定の開発成果物である場合には,この限
36 りではない.
37(3) 本ドキュメントの利用により直接的または間接的に生じるいかなる損害
38 からも,上記著作権者
39およびTOPPERSプロジェクトをå…
40è²¬ã™ã‚‹ã“と.また,
41 本ドキュメントのユーザまたはエンドユーザからのいかなる理由に基づ
42 く請求からも,上記著作権者
43およびTOPPERSプロジェクトをå…
44è²¬ã™ã‚‹ã“と.
45
46本ドキュメントは,AUTOSAR(AUTomotive Open System ARchitecture)仕様
47に基づいている.上記の許諾は,AUTOSARの知的財産権を許諾するものではな
48い.AUTOSARは,AUTOSAR仕様に基づいたソフトウェアを商用目的で利用する
49者
50に対して,AUTOSARパートナーになることを求めている.
51
52本ドキュメントは,無保証で提供されているものである.上記著作権者
53およ
54びTOPPERSプロジェクトは,本ドキュメントに関して,特定の使用目的に対す
55る適合性も含めて,いかなる保証も行わない.また,本ドキュメントの利用
56により直接的または間接的に生じたいかなる損害に関しても,その責任を負
57わない.
58
59$Id: readme.txt 571 2015-12-21 05:01:59Z t_ishikawa $
60----------------------------------------------------------------------
61
62━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
63(1) ABREX概要
64━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
65
66ABREXは,OS,COMを始めとするBSWと,RTEのコンフィギュレーションファイル
67(XML)を生成するツールである.YAMLフォーマットで記述したコンフィギュレー
68ション情
69報をå…
70¥åŠ›ã¨ã—て,対応するXMLを生成する.
71
72━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
73(2) 使い方
74━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
75———————————————————————————————————
76(2.1) 動作環境
77———————————————————————————————————
78
79ABREXはRubyによって記述されているため,Rubyの実行環境が必
80要である.
81Cygwinに含まれる以下のバージョンのRubyで動作確認済みである.
82
83ruby 1.9.3p327 (2012-11-10 revision 37606) [i386-cygwin]
84
85———————————————————————————————————
86(2.2) コンテナ情
87報の生成
88———————————————————————————————————
89※本手順は既にparam_info.yamlが存在する場合,不要である
90
91-pオプションに,AUTOSARからå…
92¬é–‹ã•ã‚Œã¦ã„ã‚‹ECUコンフィギュレーションパラ
93メータコンテナ情
94報ファイル(*)を引数として与え,実行する.
95(*)http://www.autosar.org
96 Methodology and Templates -> Templates -> Standard Specifications
97 -> AUTOSAR_MOD_ECUConfigurationParameters.zip
98 解凍すると"AUTOSAR_MOD_ECUConfigurationParameters.arxml"となる
99
100$ ruby abrex.rb -p AUTOSAR_MOD_ECUConfigurationParameters.arxml
101
102各パラメータコンテナのデータ型,外部参ç…
103§åž‹ã®å‚ç…
104§å…
105ˆæƒ…
106報などが,
107param_info.yamlに出力される.
108
109———————————————————————————————————
110(2.3) YAMLファイルの作成
111———————————————————————————————————
112生成したいXMLファイルの情
113報をYAMLフォーマットで記述する.
114・最上位のレイヤがパッケージ名,その次がECUモジュール名となる.
115・ECUモジュール名の下に該当モジュールに含まれるパラメータ名をキーとして,
116 パラメータコンテナと値をハッシュ形式で記述する.
117・サブコンテナは,ハッシュをネストすることで表現する.
118・コンテナへの参ç…
119§ã¯ï¼ŒYAMLファイルに定義したパッケージ名に従ってパスを
120 記述する.
121
122■OSの例
123
124Os:
125 Os:
126 MainApp:
127 DefinitionRef: OsAppMode
128 OsOS:
129 OsStackMonitoring: 1
130 OsStatus: EXTENDED
131 OsUseGetServiceId: 1
132 OsUseParameterAccess: 1
133 OsScalabilityClass: SC1
134 OsHooks:
135 OsErrorHook: 0
136 OsPostTaskHook: 0
137 OsPreTaskHook: 0
138 OsProtectionHook: 0
139 OsShutdownHook: 0
140 OsStartupHook: 0
141 OsHookStack:
142 OsHookStackSize: 1024
143 OsOsStack:
144 OsOsStackSize: 1024
145 TASK1:
146 DefinitionRef: OsTask
147 OsTaskActivation: 1
148 OsTaskPriority: 10
149 OsTaskSchedule: FULL
150 OsTaskStackSize: 1024
151 OsTaskEventRef: /Os/Os/EVENT1
152 OsTaskAutostart:
153 OsTaskAppModeRef: /Os/Os/MainApp
154 EVENT1:
155 DefinitionRef: OsEvent
156
157———————————————————————————————————
158(2.4) XMLファイルの生成
159———————————————————————————————————
160作成したYAMLファイルを引数として,abrex.rbを実行する.
161
162$ ruby abrex.rb ./sample.yaml
163
164å…
165¥åŠ›ã—たYAMLファイルの情
166報に対応するXMLファイルが,å…
167¥åŠ›ãƒ•ã‚¡ã‚¤ãƒ«åã®æ‹¡å¼µ
168子をarxmlに変更したファイルに出力される.
169※上記例の場合,sample.arxml
170
171・(2.1)で生成したparam_info.yamlに含まれないキー名が登場した場合,エラ
172 ー終了する.
173・サブコンテナ名はparam_info.yamlに含まれず,YAMLファイルに記述した名称
174 が正しいものとして,サブコンテナを生成する.
175・設定値の妥当性等のチェックは一切行わない.
176
177引数のYAMLファイルは複数指定することができ,すべてのYAMLファイルの情
178å ±
179をマージしたXMLファイルを生成する.同じパスのコンテナが異なるファイルに
180存在する場合,1つのコンテナにマージする.例えば,以下のa.yamlとb.yamlを
181å…
182¥åŠ›ã—た場合,MAIN_HW_COUNTERには両方のファイルに指定されたすべてのパラ
183メータが設定されたXMLファイルとなる.
184
185<a.yaml>
186Os:
187 Os:
188 MAIN_HW_COUNTER:
189 DefinitionRef: OsCounter
190 OsCounterMaxAllowedValue: 0x7FFFFFFF
191 OsCounterTicksPerBase: 10
192 OsCounterMinCycle: 4000
193 OsCounterType: HARDWARE
194 OsSecondsPerTick: 1.666666e-08
195 OsCounterIsrRef: /Os/Os/ISR1
196
197<b.yaml>
198Os:
199 Os:
200 MAIN_HW_COUNTER:
201 OsCounterAccessingApplication: OSAP1
202
203※同じパスのパラメータが複数のファイルに含まれる場合は,多重度が*と判断
204 して,複数のコンテナを生成する.(パラメータ毎の多重度情
205報は保持しない)
206
207━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
208(3) その他の機能
209━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
210———————————————————————————————————
211(3.1) XMLからYAMLを作成する(逆変換)
212———————————————————————————————————
213ABREXでは,作成済みのXMLファイルから,YAMLファイルを作成することが出来
214る.-iオプションに,AUTOSAR準拠のXMLを引数として与え,実行する.
215
216$ ruby abrex.rb -i sample.arxml
217
218å…
219¥åŠ›ã—たXMLファイルの情
220報に対応するYAMLファイルが,å…
221¥åŠ›ãƒ•ã‚¡ã‚¤ãƒ«åã®æ‹¡å¼µ
222子をyamlに変更したファイルに出力される.
223※上記例の場合,sample.yaml
224
225———————————————————————————————————
226(3.2) ジェネレータ用csvファイルの生成
227———————————————————————————————————
228TOPPERS/ATK2で使用するジェネレータ(cfg.exe)はXMLコンテナ情
229報をCSVファイ
230ルで与える必
231要があるが,ECUコンフィギュレーションパラメータコンテナ情
232å ±
233ファイルから生成することが可能である.-cオプションに,ECUコンフィギュレ
234ーションパラメータコンテナ情
235報ファイルを引数として与え,-bオプションに,
236生成する対象のモジュール名(*)を引数として与え,実行する.
237
238(*)http://www.autosar.org
239 Software Architecture -> General -> AUTOSAR_TR_BSWModuleList.pdf
240 上記ファイルに規定されているModule abbreviationで指定する.
241
242$ ruby abrex.rb -b Com -c AUTOSAR_MOD_ECUConfigurationParameters.arxml
243
244指定した対象のモジュール名のCSVファイルに出力される.
245※上記例の場合,Com.csv
246
247<注意事項
248>
249生成するCSVファイルのコンテナの短縮名は,コンテナ名をそのまま使用する.
250従って,同じ名称のコンテナが異なるコンテナのサブコンテナとして存在する
251場合は,ジェネレータ実行時に区別できなくなる.この場合,手動で区別でき
252るように修正する必
253要がある.
254
255(例)ComのComTxModeFalseとComTxModeTrueに含まれるComTxModeコンテナ
256/AUTOSAR/EcucDefs/Com/ComConfig/ComIPdu/ComTxIPdu/ComTxModeFalse/ComTxMode,ComTxMode,,1
257/AUTOSAR/EcucDefs/Com/ComConfig/ComIPdu/ComTxIPdu/ComTxModeTrue/ComTxMode,ComTxMode,,1
258
259━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
260(4) 注意事項
261
262━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
263———————————————————————————————————
264(4.1) ECUコンフィギュレーションパラメータコンテナ情
265報ファイルの誤記修正
266———————————————————————————————————
267コンテナ情
268報の生成(本ドキュメントの2.2章を参ç…
269§)において使用している,
270ECUコンフィギュレーションパラメータコンテナ情
271報ファイルである
272AUTOSAR_MOD_ECUConfigurationParameters.arxmlの誤記を修正する必
273要がある.
274
275現在判明している誤記を以下に示す.
276
277・(誤)WdgMInternallCheckpointFinalRef
278 (æ­£)WdgMInternalCheckpointFinalRef
279
280
281以上
Note: See TracBrowser for help on using the repository browser.