1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file io_block.h
* @brief I/O block devices access.
* @details This header defines abstract interfaces useful to access generic
* I/O block devices in a standardized way.
*
* @addtogroup IO_BLOCK
* @details This module define an abstract interface for accessing generic
* block devices.
* Note that no code is present, just abstract interfaces-like
* structures, you should look at the system as to a set of
* abstract C++ classes (even if written in C). This system
* has then advantage to make the access to block devices
* independent from the implementation logic.
* @{
*/
#ifndef _IO_BLOCK_H_
#define _IO_BLOCK_H_
/**
* @brief Block device info.
*/
typedef struct {
uint32_t blk_size; /**< @brief Block size in bytes. */
uint32_t blk_num; /**< @brief Total number of blocks. */
} BlockDeviceInfo;
/**
* @brief @p BaseBlockDevice specific methods.
*/
#define _base_block_device_methods \
/* Removable media detection.*/ \
bool_t is_inserted(void *instance); \
/* Removable write protection detection.*/ \
bool_t is_protected(void *instance); \
/* Connection to the block device.*/ \
bool_t (*connect)(void *instance); \
/* Disconnection from the block device.*/ \
bool_t (*disconnect)(void *instance); \
/* Reads one or more blocks.*/ \
bool_t (*read)(void *instance, uint32_t startblk, \
uint8_t *buffer, uint32_t n); \
/* Writes one or more blocks.*/ \
bool_t (*write)(void *instance, uint32_t startblk, \
const uint8_t *buffer, uint32_t n); \
/* Write operations synchronization.*/ \
bool_t (*sync)(void *instance); \
/* Obtains info about the media.*/ \
bool_t (*get_info)(void *instance, BlockDeviceInfo *bdip);
/**
* @brief @p BaseBlockDevice specific data.
* @note It is empty because @p BaseBlockDevice is only an interface
* without implementation.
*/
#define _base_block_device_data
/**
* @brief @p BaseBlockDevice virtual methods table.
*/
struct BaseBlockDeviceVMT {
_base_block_device_methods
};
/**
* @brief Base block device class.
* @details This class represents a generic, block-accessible, device.
*/
typedef struct {
/** @brief Virtual Methods Table.*/
const struct BaseBlockDeviceVMT *vmt;
_base_block_device_data
} BaseBlockDevice;
/**
* @name Macro Functions (BaseBlockDevice)
* @{
*/
/**
* @brief Returns the media insertion status.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The media state.
* @retval FALSE media not inserted.
* @retval TRUE media inserted.
*
* @api
*/
#define blkIsInserted(ip) ((ip)->vmt->is_inserted(ip))
/**
* @brief Returns the media write protection status.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The media state.
* @retval FALSE writable media.
* @retval TRUE non writable media.
*
* @api
*/
#define blkIsWriteProtected(ip) ((ip)->vmt->is_protected(ip))
/**
* @brief Performs the initialization procedure on the block device.
* @details This function should be performed before I/O operations can be
* attempted on the block device and after insertion has been
* confirmed using @p blkIsInserted().
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The operation status.
* @retval FALSE operation succeeded.
* @retval TRUE operation failed.
*
* @api
*/
#define blkConnect(ip) ((ip)->vmt->connect(ip))
/**
* @brief Terminates operations on the block device.
* @details This operation safely terminates operations on the block device.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @return The operation status.
* @retval FALSE operation succeeded.
* @retval TRUE operation failed.
*
* @api
*/
#define blkDisconnect(ip) ((ip)->vmt-disconnect(ip))
/**
* @brief Reads one or more blocks.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
* @param[in] startblk first block to read
* @param[out] buf pointer to the read buffer
* @param[in] n number of blocks to read
*
* @return The operation status.
* @retval FALSE operation succeeded.
* @retval TRUE operation failed.
*
* @api
*/
#define blkRead(ip, startblk, buffer, n) \
((ip)->vmt->read(ip, startblk, buffer, n))
/**
* @brief Writes one or more blocks.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
* @param[in] startblk first block to write
* @param[out] buf pointer to the write buffer
* @param[in] n number of blocks to write
*
* @return The operation status.
* @retval FALSE operation succeeded.
* @retval TRUE operation failed.
*
* @api
*/
#define blkWrite(ip, startblk, buffer, n) \
((ip)->vmt->write(ip, startblk, buffer, n))
/**
* @brief Ensures write synchronization.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
*
* @api
*/
#define blkSync(ip) ((ip)->vmt->sync(ip))
/**
* @brief Returns a media information structure.
*
* @param[in] ip pointer to a @p BaseBlockDevice or derived class
* @param[out] bdpi pointer to a @p BlockDeviceInfo structure
*
* @api
*/
#define blkGetInfo(ip, bdip) ((ip)->vmt->get_info(ip, bdip))
/** @} */
#endif /* _IO_BLOCK_H_ */
/** @} */
|
