OSDN Git Service

コメント、Doxygenコメント、E_PACKAGE等を整理。
[toppersasp4lpc/asp.git] / asp / target / lpc1768_generic_gcc / lpc1768_generic.h
1 /*
2  *  TOPPERS/JSP Kernel
3  *      Toyohashi Open Platform for Embedded Real-Time Systems/
4  *      Just Standard Profile Kernel
5  *
6  *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
7  *                              Toyohashi Univ. of Technology, JAPAN
8  *  Copyright (C) 2005-2007 by Embedded and Real-Time Systems Laboratory
9  *              Graduate School of Information Science, Nagoya Univ., JAPAN
10  *  Copyright (C) 2010 by TOPPERS/ASP for LPC project
11  *              http://sourceforge.jp/projects/toppersasp4lpc/
12  * 
13  *  上記著作権者は,Free Software Foundation によって公表されている 
14  *  GNU General Public License の Version 2 に記述されている条件か,以
15  *  下の(1)〜(4)の条件を満たす場合に限り,本ソフトウェア(本ソフトウェ
16  *  アを改変したものを含む.以下同じ)を使用・複製・改変・再配布(以下,
17  *  利用と呼ぶ)することを無償で許諾する.
18  *  (1) 本ソフトウェアをソースコードの形で利用する場合には,上記の著作
19  *      権表示,この利用条件および下記の無保証規定が,そのままの形でソー
20  *      スコード中に含まれていること.
21  *  (2) 本ソフトウェアを再利用可能なバイナリコード(リロケータブルオブ
22  *      ジェクトファイルやライブラリなど)の形で利用する場合には,利用
23  *      に伴うドキュメント(利用者マニュアルなど)に,上記の著作権表示,
24  *      この利用条件および下記の無保証規定を掲載すること.
25  *  (3) 本ソフトウェアを再利用不可能なバイナリコードの形または機器に組
26  *      み込んだ形で利用する場合には,次のいずれかの条件を満たすこと.
27  *    (a) 利用に伴うドキュメント(利用者マニュアルなど)に,上記の著作
28  *        権表示,この利用条件および下記の無保証規定を掲載すること.
29  *    (b) 利用の形態を,別に定める方法によって,上記著作権者に報告する
30  *        こと.
31  *  (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
32  *      害からも,上記著作権者を免責すること.
33  * 
34  *  本ソフトウェアは,無保証で提供されているものである.上記著作権者は,
35  *  本ソフトウェアに関して,その適用可能性も含めて,いかなる保証も行わ
36  *  ない.また,本ソフトウェアの利用により直接的または間接的に生じたい
37  *  かなる損害に関しても,その責任を負わない.
38  * 
39  */
40 /**
41  * \defgroup TOPPERS_ASP TOPPERS/ASP
42  */
43 /**
44  * \ingroup TOPPERS_ASP
45  * \defgroup TOPPERS_TARGET LPC1768 ターゲット依存部
46  */
47 /* \{ */
48 /**
49  * \file lpc1768_generic.h
50  * \brief ターゲットハードウェアに依存する宣言を納める
51  * \details
52  * アプリケーション、システムサービス、カーネルなどで利用されるハードウェア
53  * 関係の宣言をまとめるファイル。
54  */
55
56 /**
57  * \mainpage
58  * NXP社LPC1768用のターゲット依存部。TOPPERS/ASPターゲット非依存部1.6に対応している。
59  * 最新ソースコードは http://sourceforge.jp/projects/toppersasp4lpc/ より入手できる。
60  *
61  * クロックとして内蔵オシレーターを使用しているため、外部にオシレーターをつけなくても
62  * 動作させることができる。そのため、ほとんどのボードで動作する。オシレーターの設定を
63  * 変更する場合には、\ref target_config.cを変更するとよい。
64  *
65  * コンソールはシリアルポート1(UART0)を使用している。設定は 8 data bit, 1 start bit, 1 stop bit,
66  * none-parity, 57600baudである。使用するポートや速度を変更する場合には、\ref target_syssvc.hの内容を変更する。
67  *
68  * システム・タイマーはSYSTICK割り込みを使っている。
69  *
70  * ビルドするには、次のコマンドを実行してコンフィギュレータをビルドする。
71  * \code
72  * $ cd asp/cfg
73  * $ ./configure
74  * $ make
75  * \endcode
76  *
77  * また、アプリケーションのビルド時には、makeあるいはmake sramを使用する。makeはROM化コードを生成し、
78  * make sramはSRAM上で走るデバッグ用コードを生成する。
79  */
80
81 #ifndef TOPPERS_LPC1768_GENERIC_H
82 #define TOPPERS_LPC1768_GENERIC_H
83
84 #include <sil.h>
85
86 /*
87  *  システムクロックの定義(発振子周波数8MHz)
88  */
89 /**
90  * \brief 内蔵クロックの発信周波数
91  * \details
92  * 内蔵発振器のクロック周波数[Hz]。SYS_CLOCKが参照する。LPC1768の場合は4MHzである。
93  */
94 #define INTERNAL_CLOCK          (4000000)                       // 内蔵発振器は4MHz
95
96 /**
97  * \brief コア・クロック周波数
98  * \details
99  * CORTEX-M3コアに入力する動作クロックの周波数[Hz]。
100  */
101 #define SYS_CLOCK               (INTERNAL_CLOCK * 25)   // コアに入力するクロック 100MHz
102
103
104 #ifndef TOPPERS_MACRO_ONLY
105
106 #endif /* TOPPERS_MACRO_ONLY */
107 #endif /* TOPPERS_LPC1768_GENERIC_H */
108 /* \} */