Difference between revisions of "Board File"

From uGFX Wiki
Jump to: navigation, search
(Templates)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Certain [[Architecture#Module|modules]] have to communicate to hardware in order to fulfil their tasks. Those modules come with an additional driver layer. Each driver then needs a board file to talk to the hardware.
+
Certain [[Architecture#Module|modules]] have to communicate to hardware in order to fulfil their tasks. Those modules come with an additional driver layer. Each driver then needs a board file to talk to the actual hardware.<br/>
 +
The board file needs to be provided by the user as it's implementation depends not only on the used underlying system (HAL), but also the actual hardware configuration (wiring).
  
 
== Templates ==
 
== Templates ==
Each driver provides a template of it's board file.
+
Each driver provides a template of it's board file. Copying this file to your project directory and implementing the routines is all there is to do. Note that you have to remove the <code>_template</code> part from the file name.
 +
 
 +
== Supported Boards ==
 +
Some boards have predefined hardware on them. Where they are a common board we provide a makefile (''/boards/base/xxx/board.mk'') which you can include into your own project makefile. This will then automatically include all the standard hardware drivers and board files.
 +
Additional pre-defined board files can also be found in ''/boards/addons''.
  
 
== Modules ==
 
== Modules ==
Line 9: Line 14:
 
* [[GINPUT]]
 
* [[GINPUT]]
 
* [[GAUDIO]]
 
* [[GAUDIO]]
 +
 +
 +
[[Category:General]]

Latest revision as of 19:27, 19 December 2016

Certain modules have to communicate to hardware in order to fulfil their tasks. Those modules come with an additional driver layer. Each driver then needs a board file to talk to the actual hardware.
The board file needs to be provided by the user as it's implementation depends not only on the used underlying system (HAL), but also the actual hardware configuration (wiring).

Templates

Each driver provides a template of it's board file. Copying this file to your project directory and implementing the routines is all there is to do. Note that you have to remove the _template part from the file name.

Supported Boards

Some boards have predefined hardware on them. Where they are a common board we provide a makefile (/boards/base/xxx/board.mk) which you can include into your own project makefile. This will then automatically include all the standard hardware drivers and board files. Additional pre-defined board files can also be found in /boards/addons.

Modules

The following modules require a board file: