Revision de56f814

View differences:

README.txt
47 47
#                                                                              #
48 48
################################################################################
49 49

  
50
This file provides information about the purpose of this project, the file
51
structure and some helpful guides for development of code.
52

  
53
================================================================================
54

  
55
CONTENTS:
56

  
57
  1  About the Project
58
  2  File Structure
59
  3  Developer Guides
60
    3.1  Adding a Device
61
    3.2  Implementing a Driver
62

  
63
================================================================================
64

  
65

  
66

  
67
1 - ABOUT THE PROJECT
68
=====================
69

  
50 70
AMiRo-LLD is a compilation of low-level hardware drivers, originally developed
51 71
for the Autonomous Mini Robot (AMiRo) [1]. It provides a modular design, so that
52 72
each driver can be activated individually as required. Interface functions allow
......
55 75
to be implemented by the operating system) and any applications (or the
56 76
operating system itself) can take advantage of the drivers by their individual
57 77
interfaces. The abstraction layer of the hardware interfaces is called
58
"periphAL", which is defined by this project.
78
"periphAL", which is defined by this project. In order to configure which
79
drivers should be used in which version, the project expects an according file
80
"alldconf.h" to be found in the include paths.
59 81

  
60 82
Although this compilation was originally designed to be used in combination with
61 83
the AMiRo operating system (AMiRo-OS; cf. https://opensource.cit-ec.de/projects/amiro-os/),
......
63 85
purpose and contributions of further drivers, even if the according hardware is
64 86
not present on the AMiRo platform, are highly appreciated.
65 87

  
88

  
89

  
90
2 - FILE STRUCTURE
91
==================
92

  
66 93
The files are structured as follows:
67 94
./
68 95
│ The project root directory contains this file, a license.html file as well as
......
72 99
│ recommended) to include each driver individually.
73 100
74 101
├── include/
75
│     Each driver defines exactly one include header in this directory. By
76
│     convention these files are named by the form
77
│     alld_<product_name>.h
102
│     For each supported hardware device, there is exactly one directory in this
103
│     folder. Further subfolders may contain various versions of a driver (e.g.
104
│     'v1/', 'v2/', etc.). By convention the root directory of a driver is named
105
│     by the form
106
│     "<product_name>/"
78 107
│     <product_name> is a placeholder for the exact name of the according
79 108
│     hardware, or the product familiy, if the driver is compatible with all
80 109
│     parts.
110
│     The root header consequently follows the naming scheme
111
│     "alld_<product_name>.h"
112
│     and header files within the version folders shall be named like
113
│     "alld<product_name>_<driver_version>.h"
81 114
82 115
├── source/
83
│     Any source files are placed in this directory. Usually there is a single
84
│     file for each driver. If multiple files are necessary, these should be
85
│     placed in an accordingly named subfolder. Names of folders and files
86
│     should comply to the aforementioned convention.
116
│     Any source files are placed in this directory. Naming conventions for
117
│     folders and files are the same as described before for the include
118
│     directory, as is the file structure. There is a dedicated folder for each
119
│     device and further subfolders for multiple driver versions. Source files
120
│     should only be put in these version folders.
87 121
88 122
└── templates/
89 123
      AMiRo-LLD requires an implementation of the defined interface and an
......
92 126
      recommended to place according implementations of these templated not in
93 127
      the AMiRo-LLD project, but the superproject which includes AMiRo-LLD.
94 128

  
129

  
130

  
131
3 - DEVELOPER GUIDES
132
====================
133

  
134
In order to keep all code within this project as homogeneous as possible, the
135
guides of these chapters should help developers to achieve functional and clean
136
results, which are portable and maintainable for future use. Whereas the textual
137
descriptions of the guides provide additional information about the underlying
138
concepts and mechanisms, a short summary is provided at the end of each chapter.
139

  
140
3.1  Adding a Device
141
--------------------
142

  
143
When adding new device to the project, the very first step is to create the
144
according folders in the include/ and source/ directories. For this guide, we
145
will add the fictional DEVICE1234. For this example the folders to be created
146
are "include/DEVICE1234/" and "source/DEVICE1234/".
147

  
148
The first file should be the root header: "include/DEVICE1234/alld_DEVICE1234.h"
149
Have a look at existing drivers and use one of those as template. This header
150
should introduce a new configuration to be set in the alldconf.h file and check
151
it using the preprocessor. Eventually, another header is included, pointing to
152
the selected driver version/implementation.
153

  
154
Such implementations are to be put in further subfolders, e.g.
155
"include/DEVICE1234/v1/" and "source/DEVICE1234/v1/". The header and C-source
156
files in those folders do not follow a strict scheme, although there are some
157
conventions to consider (i.e. naming conventions, cf. chapter 2).
158

  
159
Summing up, you have to
160
1) create device folders.
161
2) add a root header.
162
3) add further subfolders and implement the driver there.
163

  
164

  
165
3.2  Implementing a Driver
166
--------------------------
167

  
168
Implementation of a new driver usually is very straight-forward. You most
169
probably have a comprehensive datasheet of the device, or the manufacturer even
170
provides a reference driver implementation.
171

  
172
For the former case, you should first write a comprehensive header, containing
173
all information like constants, register maps, etc. and according abstract
174
access functions (e.g. for reading and writing registers, and convenient access
175
to common functionalities). Only the you implement those functions, using
176
periphAL to interface any hardware interfaces (e.g. I2C, SPI, etc.).
177

  
178
For the latter case, the reference implementation will specify some interface
179
functions to interact with the hardware (e.g. I2C, SPI etc.). Even though all
180
functionality should be covered by the reference driver, you still need to
181
implement those interface functions.
182

  
183
Since AMiRo-LLD does not rely on specific hardware or operating system, the only
184
valid way to interact with both is through periphAL. Under no circumstances you
185
must use any function of your operating system and directly or indirectly access
186
the hardware of your platform. For your driver, there is no knowledge about the
187
world beyond periphAL! If periphAL does not provide the function you need, you
188
can do the following: 1) Think again if you really need that funcionality or
189
whether it can be replicated by existing functions. 2) File a feature request
190
to extend periphAL. 3) Write a custom patch that modifies periphAL to meet your
191
requirements.
192

  
193
Summing up, you have to
194
1) Get and read the datasheet of the device (A) or
195
   acquire a copy of the reference implementation (B).
196
2) Case A: define constants, register map and access functions in a header file.
197
   Case B: identify the interface functions of the reference implementation.
198
3) Implement the missing functions using periphAL.
199

  
95 200
================================================================================
96 201

  

Also available in: Unified diff