/* ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio. This file is part of ChibiOS. ChibiOS 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 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 . */ /** * @file chmboxes.h * @brief Mailboxes macros and structures. * * @addtogroup mailboxes * @{ */ #ifndef CHMBOXES_H #define CHMBOXES_H #if !defined(CH_CFG_USE_MAILBOXES) #define CH_CFG_USE_MAILBOXES FALSE #endif #if (CH_CFG_USE_MAILBOXES == TRUE) || defined(__DOXYGEN__) /*===========================================================================*/ /* Module constants. */ /*===========================================================================*/ /*===========================================================================*/ /* Module pre-compile time settings. */ /*===========================================================================*/ /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ /*===========================================================================*/ /* Module data structures and types. */ /*===========================================================================*/ /** * @brief Structure representing a mailbox object. */ typedef struct { msg_t *buffer; /**< @brief Pointer to the mailbox buffer. */ msg_t *top; /**< @brief Pointer to the location after the buffer. */ msg_t *wrptr; /**< @brief Write pointer. */ msg_t *rdptr; /**< @brief Read pointer. */ size_t cnt; /**< @brief Messages in queue. */ bool reset; /**< @brief True in reset state. */ threads_queue_t qw; /**< @brief Queued writers. */ threads_queue_t qr; /**< @brief Queued readers. */ } mailbox_t; /*===========================================================================*/ /* Module macros. */ /*===========================================================================*/ /** * @brief Data part of a static mailbox initializer. * @details This macro should be used when statically initializing a * mailbox that is part of a bigger structure. * * @param[in] name the name of the mailbox variable * @param[in] buffer pointer to the mailbox buffer array of @p msg_t * @param[in] size number of @p msg_t elements in the buffer array */ #define _MAILBOX_DATA(name, buffer, size) { \ (msg_t *)(buffer), \ (msg_t *)(buffer) + size, \ (msg_t *)(buffer), \ (msg_t *)(buffer), \ (size_t)0, \ false, \ _THREADS_QUEUE_DATA(name.qw), \ _THREADS_QUEUE_DATA(name.qr), \ } /** * @brief Static mailbox initializer. * @details Statically initialized mailboxes require no explicit * initialization using @p chMBObjectInit(). * * @param[in] name the name of the mailbox variable * @param[in] buffer pointer to the mailbox buffer array of @p msg_t * @param[in] size number of @p msg_t elements in the buffer array */ #define MAILBOX_DECL(name, buffer, size) \ mailbox_t name = _MAILBOX_DATA(name, buffer, size) /*===========================================================================*/ /* External declarations. */ /*===========================================================================*/ #ifdef __cplusplus extern "C" { #endif void chMBObjectInit(mailbox_t *mbp, msg_t *buf, size_t n); void chMBReset(mailbox_t *mbp); void chMBResetI(mailbox_t *mbp); msg_t chMBPostTimeout(mailbox_t *mbp, msg_t msg, sysinterval_t timeout); msg_t chMBPostTimeoutS(mailbox_t *mbp, msg_t msg, sysinterval_t timeout); msg_t chMBPostI(mailbox_t *mbp, msg_t msg); msg_t chMBPostAheadTimeout(mailbox_t *mbp, msg_t msg, sysinterval_t timeout); msg_t chMBPostAheadTimeoutS(mailbox_t *mbp, msg_t msg, sysinterval_t timeout); msg_t chMBPostAheadI(mailbox_t *mbp, msg_t msg); msg_t chMBFetchTimeout(mailbox_t *mbp, msg_t *msgp, sysinterval_t timeout); msg_t chMBFetchTimeoutS(mailbox_t *mbp, msg_t *msgp, sysinterval_t timeout); msg_t chMBFetchI(mailbox_t *mbp, msg_t *msgp); #ifdef __cplusplus } #endif /*===========================================================================*/ /* Module inline functions. */ /*===========================================================================*/ /** * @brief Returns the mailbox buffer size as number of messages. * * @param[in] mbp the pointer to an initialized mailbox_t object * @return The size of the mailbox. * * @iclass */ static inline size_t chMBGetSizeI(const mailbox_t *mbp) { /*lint -save -e9033 [10.8] Perfectly safe pointers arithmetic.*/ return (size_t)(mbp->top - mbp->buffer); /*lint -restore*/ } /** * @brief Returns the number of used message slots into a mailbox. * * @param[in] mbp the pointer to an initialized mailbox_t object * @return The number of queued messages. * @retval QUEUE_RESET if the queue is in reset state. * * @iclass */ static inline size_t chMBGetUsedCountI(const mailbox_t *mbp) { chDbgCheckClassI(); return mbp->cnt; } /** * @brief Returns the number of free message slots into a mailbox. * * @param[in] mbp the pointer to an initialized mailbox_t object * @return The number of empty message slots. * * @iclass */ static inline size_t chMBGetFreeCountI(const mailbox_t *mbp) { chDbgCheckClassI(); return chMBGetSizeI(mbp) - chMBGetUsedCountI(mbp); } /** * @brief Returns the next message in the queue without removing it. * @pre A message must be waiting in the queue for this function to work * or it would return garbage. The correct way to use this macro is * to use @p chMBGetFullCountI() and then use this macro, all within * a lock state. * * @param[in] mbp the pointer to an initialized mailbox_t object * @return The next message in queue. * * @iclass */ static inline msg_t chMBPeekI(const mailbox_t *mbp) { chDbgCheckClassI(); return *mbp->rdptr; } /** * @brief Terminates the reset state. * * @param[in] mbp the pointer to an initialized mailbox_t object * * @xclass */ static inline void chMBResumeX(mailbox_t *mbp) { mbp->reset = false; } #endif /* CH_CFG_USE_MAILBOXES == TRUE */ #endif /* CHMBOXES_H */ /** @} */ n144'>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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381