andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added HAL Abstract Peripheral Interfaces documentation 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10289 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
roccomarco 2017-07-02 10:24:43 +00:00
parent 28202cd23b
commit 82580b3660
13 changed files with 5205 additions and 4835 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4909
doc/hal/Doxyfile_chm
View File

File diff suppressed because it is too large Load Diff

4909
doc/hal/Doxyfile_html
View File

File diff suppressed because it is too large Load Diff

22
os/hal/dox/accelerometer.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_ACCELEROMETER Generic Accelerometer Interface
* @brief HAL Generic Accelerometer Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/barometer.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_BAROMETER Generic Barometer Interface
* @brief HAL Generic Barometer Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/compass.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_COMPASS Generic Compass Interface
* @brief HAL Generic Compass Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/flash.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_FLASH Generic Flash Driver Interface
* @brief HAL Generic Flash Driver Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/gyro.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_GYROSCOPE Generic Gyroscope Interface
* @brief HAL Generic Gyroscope Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/hal_peripherals.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_ABSTRACT_PERIPHERALS Abstract Peripheral Interfaces
* @brief HAL Abstract Peripheral Interfaces.
*
* @ingroup HAL_INTERFACES
*/

22
os/hal/dox/hygrometer.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_HYGROMETER Generic Hygrometer Interface
* @brief HAL Generic Hygrometer Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/jesd216flash.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_JESD216_FLASH JESD216 Compliant Flash Driver Interface
* @brief HAL JESD216 Compliant Flash Driver Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

2
os/hal/dox/main.dox
View File

@ -119,7 +119,7 @@
*
* @ingroup IO
*/
/**
* @defgroup HAL_INNER_CODE Inner Code
* @brief HAL Inner Code.

22
os/hal/dox/sensor.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_SENSORS Generic Sensor Interface
* @brief HAL Generic Sensor Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/

22
os/hal/dox/thermometer.dox Normal file
View File

@ -0,0 +1,22 @@
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_THERMOMETER Generic Thermometer Interface
* @brief HAL Generic Thermometer Interface.
*
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/