aboutsummaryrefslogtreecommitdiff
path: root/lib/chibios/os/hal/dox/hal_sdc.dox
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chibios/os/hal/dox/hal_sdc.dox')
-rw-r--r--lib/chibios/os/hal/dox/hal_sdc.dox33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/chibios/os/hal/dox/hal_sdc.dox b/lib/chibios/os/hal/dox/hal_sdc.dox
new file mode 100644
index 000000000..887e1005d
--- /dev/null
+++ b/lib/chibios/os/hal/dox/hal_sdc.dox
@@ -0,0 +1,33 @@
1/*
2 ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15*/
16
17/**
18 * @defgroup SDC SDC Driver
19 * @brief Generic SD Card Driver.
20 * @details This module implements a generic SDC (Secure Digital Card) driver.
21 * @pre In order to use the SDC driver the @p HAL_USE_SDC option
22 * must be enabled in @p halconf.h.
23 *
24 * @section sdc_1 Driver State Machine
25 * This driver implements a state machine internally, see the @ref IO_BLOCK
26 * module documentation for details.
27 *
28 * @section sdc_2 Driver Operations
29 * This driver allows to read or write single or multiple 512 bytes blocks
30 * on a SD Card.
31 *
32 * @ingroup HAL_NORMAL_DRIVERS
33 */