/* ChibiOS - Copyright (C) 2006..2015 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 chdebug.h * @brief Debug macros and structures. * * @addtogroup debug * @{ */ #ifndef _CHDEBUG_H_ #define _CHDEBUG_H_ /*===========================================================================*/ /* Module constants. */ /*===========================================================================*/ /*===========================================================================*/ /* Module pre-compile time settings. */ /*===========================================================================*/ /** * @name Debug related settings * @{ */ /** * @brief Trace buffer entries. */ #ifndef CH_DBG_TRACE_BUFFER_SIZE #define CH_DBG_TRACE_BUFFER_SIZE 64 #endif /** * @brief Fill value for thread stack area in debug mode. */ #ifndef CH_DBG_STACK_FILL_VALUE #define CH_DBG_STACK_FILL_VALUE 0x55 #endif /** * @brief Fill value for thread area in debug mode. * @note The chosen default value is 0xFF in order to make evident which * thread fields were not initialized when inspecting the memory with * a debugger. A uninitialized field is not an error in itself but it * better to know it. */ #ifndef CH_DBG_THREAD_FILL_VALUE #define CH_DBG_THREAD_FILL_VALUE 0xFF #endif /** @} */ /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ /*===========================================================================*/ /* Module data structures and types. */ /*===========================================================================*/ #if (CH_DBG_ENABLE_TRACE == TRUE) || defined(__DOXYGEN__) /** * @brief Trace buffer record. */ typedef struct { /** * @brief Time of the switch event. */ systime_t se_time; /** * @brief Switched in thread. */ thread_t *se_tp; /** * @brief Object where going to sleep. */ void *se_wtobjp; /** * @brief Switched out thread state. */ uint8_t se_state; } ch_swc_event_t; /** * @brief Trace buffer header. */ typedef struct { /** * @brief Trace buffer size (entries). */ unsigned tb_size; /** * @brief Pointer to the buffer front. */ ch_swc_event_t *tb_ptr; /** * @brief Ring buffer. */ ch_swc_event_t tb_buffer[CH_DBG_TRACE_BUFFER_SIZE]; } ch_trace_buffer_t; #endif /* CH_DBG_ENABLE_TRACE */ /*===========================================================================*/ /* Module macros. */ /*===========================================================================*/ #if CH_DBG_SYSTEM_STATE_CHECK == TRUE #define _dbg_enter_lock() (ch.dbg.lock_cnt = (cnt_t)1) #define _dbg_leave_lock() (ch.dbg.lock_cnt = (cnt_t)0) #endif /* When the state checker feature is disabled then the following functions are replaced by an empty macro.*/ #if CH_DBG_SYSTEM_STATE_CHECK == FALSE #define _dbg_enter_lock() #define _dbg_leave_lock() #define _dbg_check_disable() #define _dbg_check_suspend() #define _dbg_check_enable() #define _dbg_check_lock() #define _dbg_check_unlock() #define _dbg_check_lock_from_isr() #define _dbg_check_unlock_from_isr() #define _dbg_check_enter_isr() #define _dbg_check_leave_isr() #define chDbgCheckClassI() #define chDbgCheckClassS() #endif /* When the trace feature is disabled this function is replaced by an empty macro.*/ #if CH_DBG_ENABLE_TRACE == FALSE #define _dbg_trace(otp) #endif /** * @name Macro Functions * @{ */ /** * @brief Function parameters check. * @details If the condition check fails then the kernel panics and halts. * @note The condition is tested only if the @p CH_DBG_ENABLE_CHECKS switch * is specified in @p chconf.h else the macro does nothing. * * @param[in] c the condition to be verified to be true * * @api */ #if !defined(chDbgCheck) #define chDbgCheck(c) do { \ /*lint -save -e506 -e774 [2.1, 14.3] Can be a constant by design.*/ \ if (CH_DBG_ENABLE_CHECKS != FALSE) { \ if (!(c)) { \ /*lint -restore*/ \ chSysHalt(__func__); \ } \ } \ } while (false) #endif /* !defined(chDbgCheck) */ /** * @brief Condition assertion. * @details If the condition check fails then the kernel panics with a * message and halts. * @note The condition is tested only if the @p CH_DBG_ENABLE_ASSERTS switch * is specified in @p chconf.h else the macro does nothing. * @note The remark string is not currently used except for putting a * comment in the code about the assertion. * * @param[in] c the condition to be verified to be true * @param[in] r a remark string * * @api */ #if !defined(chDbgAssert) #define chDbgAssert(c, r) do { \ /*lint -save -e506 -e774 [2.1, 14.3] Can be a constant by design.*/ \ if (CH_DBG_ENABLE_ASSERTS != FALSE) { \ if (!(c)) { \ /*lint -restore*/ \ chSysHalt(__func__); \ } \ } \ } while (false) #endif /* !defined(chDbgAssert) */ /** @} */ /*===========================================================================*/ /* External declarations. */ /*===========================================================================*/ #ifdef __cplusplus extern "C" { #endif #if CH_DBG_SYSTEM_STATE_CHECK == TRUE void _dbg_check_disable(void); void _dbg_check_suspend(void); void _dbg_check_enable(void); void _dbg_check_lock(void); void _dbg_check_unlock(void); void _dbg_check_lock_from_isr(void); void _dbg_check_unlock_from_isr(void); void _dbg_check_enter_isr(void); void _dbg_check_leave_isr(void); void chDbgCheckClassI(void); void chDbgCheckClassS(void); #endif #if (CH_DBG_ENABLE_TRACE == TRUE) || defined(__DOXYGEN__) void _dbg_trace_init(void); void _dbg_trace(thread_t *otp); #endif #ifdef __cplusplus } #endif /*===========================================================================*/ /* Module inline functions. */ /*===========================================================================*/ #endif /* _CHDEBUG_H_ */ /** @} */ n151'>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 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663