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 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 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
use core::{fmt, mem::transmute}; /// The macro to define [`ResultCode`]. macro_rules! define_result_code { ( $( #[$meta:meta] )* pub enum ResultCode { $( $( #[$vmeta:meta] )* $vname:ident = $vd:expr ),* $(,)* } ) => { $( #[$meta] )* pub enum ResultCode { $( $( #[$vmeta] )* $vname = $vd ),* } impl ResultCode { /// Get the short name of the result code. /// /// # Examples /// /// ``` /// use r3::kernel::ResultCode; /// assert_eq!(ResultCode::BadObjectState.as_str(), "BadObjectState"); /// ``` pub fn as_str(self) -> &'static str { match self { $( Self::$vname => stringify!($vname), )* } } fn fmt(self, f: &mut fmt::Formatter) -> fmt::Result { f.write_str(self.as_str()) } } impl fmt::Debug for ResultCode { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { (*self).fmt(f) } } }; } define_result_code! { /// All result codes (including success) that the C API can return. /// /// <div class="admonition-follows"></div> /// /// > **Relation to Other Specifications:** All error codes are intentionally /// > matched to their equivalents in μITRON4.0 for no particular reasons. /// /// <div class="admonition-follows"></div> /// /// > **Rationale:** Using the C API result codes internally reduces the /// > interop overhead at an API surface. /// #[doc(include = "../common.md")] #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] #[repr(i8)] pub enum ResultCode { /// The operation was successful. No additional information is available. Success = 0, /// The operation is not supported. NotSupported = -9, /// A parameter is invalid in a way that is no covered by any other error /// codes. BadParam = -17, /// A specified object identifier ([`Id`]) is invalid. /// /// [`Id`]: super::Id BadId = -18, /// The current context disallows the operation. BadContext = -25, /// The caller does not own the resource. NotOwner = -29, /// Resource deadlock would occur. WouldDeadlock = -30, /// A target object is in a state that disallows the operation. BadObjectState = -41, /// An operation or an object couldn't be enqueued because there are too /// many of such things that already have been enqueued. QueueOverflow = -43, /// The owner of a mutex exited while holding the mutex lock. Abandoned = -44, /// The wait operation was interrupted by [`Task::interrupt`]. /// /// [`Task::interrupt`]: crate::kernel::Task::interrupt Interrupted = -49, /// The operation timed out. Timeout = -50, } } impl ResultCode { /// Get a flag indicating whether the code represents a failure. /// /// Failure codes have negative values. #[inline] pub fn is_err(self) -> bool { (self as i8) < 0 } /// Get a flag indicating whether the code represents a success. /// /// Success codes have non-negative values. #[inline] pub fn is_ok(self) -> bool { !self.is_err() } } macro_rules! define_error { ( mod $mod_name:ident {} $( #[$meta:meta] )* $vis:vis enum $name:ident $(: $($subty:ident),* $(,)*)? { $( $( #[$vmeta:meta] )* $vname:ident ),* $(,)* } ) => { $( #[$meta] )* /// /// See [`ResultCode`] for all result codes and generic descriptions. #[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)] #[repr(i8)] $vis enum $name { $( $( #[$vmeta] )* // Use the same discriminants as `ResultCode` for cost-free // conversion $vname = ResultCode::$vname as i8 ),* } impl fmt::Debug for $name { #[inline] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { ResultCode::from(*self).fmt(f) } } impl From<Result<(), $name>> for ResultCode { #[inline] fn from(x: Result<(), $name>) -> Self { match x { Ok(()) => Self::Success, Err(e) => Self::from(e), } } } impl From<$name> for ResultCode { #[inline] fn from(x: $name) -> Self { // Safety: `ResultCode` and `$name` has the same representation // type, and the representation of `ResultCode` is a // superset of `x`. unsafe { transmute(x) } } } #[cfg(test)] mod $mod_name { use super::*; #[test] fn to_result_code() { $( assert_eq!( ResultCode::$vname, ResultCode::from($name::$vname), ); )* } #[test] fn result_to_result_code() { $( assert_eq!( ResultCode::$vname, ResultCode::from(Err($name::$vname)), ); )* assert_eq!( ResultCode::Success, ResultCode::from(Result::<(), $name>::Ok(())), ); } } $($( $subty!(impl From<_> for $name); )*)? #[allow(unused_macros)] macro_rules! $name { (impl From<_> for $dest_ty:ty) => { impl From<$name> for $dest_ty { #[inline] fn from(x: $name) -> Self { match x { $( $name::$vname => Self::$vname, )* } } } }; } }; } define_error! { mod bad_context_error {} pub(super) enum BadContextError { BadContext, } } define_error! { mod bad_id_error {} pub(super) enum BadIdError { BadId, } } define_error! { mod bad_param_error {} pub(super) enum BadParamError { BadParam, } } define_error! { mod bad_object_state_error {} pub(super) enum BadObjectStateError { BadObjectState, } } define_error! { mod activate_task_error {} /// Error type for [`Task::activate`]. /// /// [`Task::activate`]: super::Task::activate pub enum ActivateTaskError: BadContextError, BadIdError { /// The task ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The task is already active (not in the Dormant state). /// /// This error code originates from `E_QOVR` defined in the μITRON 4.0 /// specification. In this specification, the `act_tsk` (activate task) /// system service works by enqueueing an activation request. `E_QOVR` /// is used to report a condition in which an enqueue count limit has /// been reached. Our kernel doesn't support enqueueing activation /// request (at the moment), so any attempts to activate an /// already-active task will fail. QueueOverflow, } } define_error! { mod get_current_task_error {} /// Error type for [`Task::current`]. /// /// [`Task::current`]: super::Task::current pub enum GetCurrentTaskError: BadContextError { /// CPU Lock is active. BadContext, } } define_error! { mod interrupt_task_error {} /// Error type for [`Task::interrupt`]. /// /// [`Task::interrupt`]: super::Task::interrupt pub enum InterruptTaskError: BadContextError, BadIdError, BadObjectStateError { /// The task ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The task is not in the Waiting state. BadObjectState, } } define_error! { mod set_task_priority_error {} /// Error type for [`Task::set_priority`]. /// /// [`Task::set_priority`]: super::Task::set_priority pub enum SetTaskPriorityError: BadContextError, BadIdError { /// The task ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The priority is out of range, or the task owns a mutex created with /// with the protocol attribute having the value [`Ceiling`] and the /// task's new priority is higher than the mutex's priority ceiling. /// /// [`Ceiling`]: crate::kernel::MutexProtocol::Ceiling BadParam, /// The task is in the Dormant state. BadObjectState, } } define_error! { mod get_task_priority_error {} /// Error type for [`Task::priority`]. /// /// [`Task::priority`]: super::Task::priority pub enum GetTaskPriorityError: BadContextError, BadIdError { /// The task ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The task is in the Dormant state. BadObjectState, } } define_error! { mod exit_task_error {} /// Error type for [`Kernel::exit_task`]. /// /// [`Kernel::exit_task`]: super::Kernel::exit_task pub enum ExitTaskError: BadContextError { /// CPU Lock is active, or the current context is not a task context. BadContext, } } define_error! { mod cpu_lock_error {} /// Error type for [`Kernel::acquire_cpu_lock`] and /// [`Kernel::release_cpu_lock`]. /// /// [`Kernel::acquire_cpu_lock`]: super::Kernel::acquire_cpu_lock /// [`Kernel::release_cpu_lock`]: super::Kernel::release_cpu_lock pub enum CpuLockError: BadContextError { /// CPU Lock is already active or inactive. BadContext, } } define_error! { mod boost_priority_error {} /// Error type for [`Kernel::boost_priority`] and /// [`Kernel::unboost_priority`]. /// /// [`Kernel::boost_priority`]: super::Kernel::boost_priority /// [`Kernel::unboost_priority`]: super::Kernel::unboost_priority pub enum BoostPriorityError: BadContextError { /// Priority Boost is already active or inactive, the current /// context is not a task context, or CPU Lock is active. BadContext, } } define_error! { mod time_error {} /// Error type for [`Kernel::time`] and /// [`Kernel::set_time`]. /// /// [`Kernel::time`]: super::Kernel::time /// [`Kernel::set_time`]: super::Kernel::set_time pub enum TimeError: BadContextError { /// The current context is not a task context, or CPU Lock is active. BadContext, } } define_error! { mod adjust_time_error {} /// Error type for [`Kernel::adjust_time`]. /// /// [`Kernel::adjust_time`]: super::Kernel::adjust_time pub enum AdjustTimeError: BadContextError { /// CPU Lock is active. BadContext, /// The requested adjustment is not possible under the current system /// state. BadObjectState, } } define_error! { mod wait_error {} /// Error type for wait operations such as [`EventGroup::wait`]. /// /// [`EventGroup::wait`]: super::EventGroup::wait pub enum WaitError { Interrupted, } } define_error! { mod wait_timeout_error {} /// Error type for wait operations with timeout such as /// [`EventGroup::wait_timeout`]. /// /// [`EventGroup::wait_timeout`]: super::EventGroup::wait_timeout pub enum WaitTimeoutError: WaitError { Interrupted, Timeout, } } impl WaitTimeoutError { /// Convert `self` to `WaitError`, panicking if `self == Self::Timeout`. pub(super) fn expect_not_timeout(self) -> WaitError { match self { Self::Interrupted => WaitError::Interrupted, Self::Timeout => panic!("got timeout result for a non-timeout wait"), } } } define_error! { mod park_error {} /// Error type for [`Kernel::park`]. /// /// [`Kernel::park`]: super::Kernel::park pub enum ParkError: BadContextError, WaitError { /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, } } define_error! { mod park_timeout_error {} /// Error type for [`Kernel::park_timeout`]. /// /// [`Kernel::park_timeout`]: super::Kernel::park_timeout pub enum ParkTimeoutError: BadContextError, WaitTimeoutError, BadParamError { /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, Timeout, /// The timeout duration is negative. BadParam, } } define_error! { mod unpark_error {} /// Error type for [`Task::unpark`]. /// /// [`Task::unpark`]: super::Task::unpark pub enum UnparkError: BadContextError, BadIdError { /// CPU Lock is active. BadContext, /// The task ID is out of range. BadId, /// The task is in the Dormant state. BadObjectState, } } define_error! { mod unpark_exact_error {} /// Error type for [`Task::unpark_exact`]. /// /// [`Task::unpark_exact`]: super::Task::unpark_exact pub enum UnparkExactError: BadContextError, BadIdError { /// CPU Lock is active. BadContext, /// The task ID is out of range. BadId, /// The task already has a token. QueueOverflow, /// The task is in the Dormant state. BadObjectState, } } define_error! { mod sleep_error {} /// Error type for [`Kernel::sleep`]. /// /// [`Kernel::sleep`]: super::Kernel::sleep pub enum SleepError: BadContextError, BadParamError { /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, /// The duration is negative. BadParam, } } define_error! { mod update_event_group_error {} /// Error type for [`EventGroup::set`] and [`EventGroup::clear`]. /// /// [`EventGroup::set`]: super::EventGroup::set /// [`EventGroup::clear`]: super::EventGroup::clear pub enum UpdateEventGroupError: BadContextError, BadIdError { /// The event group ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod get_event_group_error {} /// Error type for [`EventGroup::get`]. /// /// [`EventGroup::get`]: super::EventGroup::get pub enum GetEventGroupError: BadContextError, BadIdError { /// The event group ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod poll_event_group_error {} /// Error type for [`EventGroup::poll`]. /// /// [`EventGroup::poll`]: super::EventGroup::poll pub enum PollEventGroupError: BadContextError, BadIdError { /// The event group ID is out of range. BadId, /// CPU Lock is active. BadContext, Timeout, } } define_error! { mod wait_event_group_error {} /// Error type for [`EventGroup::wait`]. /// /// [`EventGroup::wait`]: super::EventGroup::wait pub enum WaitEventGroupError: BadContextError, BadIdError, WaitError { /// The event group ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, } } define_error! { mod wait_event_group_timeout_error {} /// Error type for [`EventGroup::wait_timeout`]. /// /// [`EventGroup::wait_timeout`]: super::EventGroup::wait_timeout pub enum WaitEventGroupTimeoutError: BadContextError, BadIdError, WaitTimeoutError, BadParamError { /// The event group ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, Timeout, /// The timeout duration is negative. BadParam, } } define_error! { mod get_semaphore_error {} /// Error type for [`Semaphore::get`]. /// /// [`Semaphore::get`]: super::Semaphore::get pub enum GetSemaphoreError: BadContextError, BadIdError { /// The semaphore ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod drain_semaphore_error {} /// Error type for [`Semaphore::drain`]. /// /// [`Semaphore::drain`]: super::Semaphore::drain pub enum DrainSemaphoreError: BadContextError, BadIdError { /// The semaphore ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod signal_semaphore_error {} /// Error type for [`Semaphore::signal`]. /// /// [`Semaphore::signal`]: super::Semaphore::signal pub enum SignalSemaphoreError: BadContextError, BadIdError { /// The semaphore ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The semaphore value is already at the maximum value. QueueOverflow, } } define_error! { mod poll_semaphore_error {} /// Error type for [`Semaphore::poll_one`]. /// /// [`Semaphore::poll_one`]: super::Semaphore::poll_one pub enum PollSemaphoreError: BadContextError, BadIdError { /// The semaphore ID is out of range. BadId, /// CPU Lock is active. BadContext, Timeout, } } define_error! { mod wait_semaphore_error {} /// Error type for [`Semaphore::wait_one`]. /// /// [`Semaphore::wait_one`]: super::Semaphore::wait_one pub enum WaitSemaphoreError: BadContextError, BadIdError, WaitError { /// The semaphore ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, } } define_error! { mod wait_semaphore_timeout_error {} /// Error type for [`Semaphore::wait_one_timeout`]. /// /// [`Semaphore::wait_one_timeout`]: super::Semaphore::wait_one_timeout pub enum WaitSemaphoreTimeoutError: BadContextError, BadIdError, WaitTimeoutError, BadParamError { /// The semaphore ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, Timeout, /// The timeout duration is negative. BadParam, } } define_error! { mod query_mutex_error {} /// Error type for [`Mutex::is_locked`]. /// /// [`Mutex::is_locked`]: super::Mutex::is_locked pub enum QueryMutexError: BadContextError, BadIdError { /// The mutex ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod unlock_mutex_error {} /// Error type for [`Mutex::unlock`]. /// /// [`Mutex::unlock`]: super::Mutex::unlock pub enum UnlockMutexError: BadContextError, BadIdError { /// The mutex ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, /// The current task does not currently own the mutex. NotOwner, /// The correct mutex unlocking order is violated. BadObjectState, } } define_error! { mod lock_mutex_precheck_error {} /// Some of the error codes shared by [`TryLockMutexError`], /// [`LockMutexError`], and [`LockMutexTimeoutError`]. Used internally /// by the mutex implementation. pub(super) enum LockMutexPrecheckError { /// The current task already owns the mutex. WouldDeadlock, /// The mutex was created with the protocol attribute having the value /// [`Ceiling`] and the current task's priority is higher than the /// mutex's priority ceiling. /// /// [`Ceiling`]: crate::kernel::MutexProtocol::Ceiling BadParam, } } define_error! { mod try_lock_mutex_error {} /// Error type for [`Mutex::try_lock`]. /// /// [`Mutex::try_lock`]: super::Mutex::try_lock pub enum TryLockMutexError: BadContextError, BadIdError, LockMutexPrecheckError { /// The mutex ID is out of range. BadId, /// CPU Lock is active, or the current context is not a [task context]. /// /// [task context]: crate#contexts BadContext, Timeout, /// The current task already owns the mutex. WouldDeadlock, /// The mutex was created with the protocol attribute having the value /// [`Ceiling`] and the current task's priority is higher than the /// mutex's priority ceiling. /// /// [`Ceiling`]: crate::kernel::MutexProtocol::Ceiling BadParam, /// The previous owning task exited while holding the mutex lock. *The /// current task shall hold the mutex lock*, but is up to make the /// state consistent. Abandoned, } } define_error! { mod lock_mutex_error {} /// Error type for [`Mutex::lock`]. /// /// [`Mutex::lock`]: super::Mutex::lock pub enum LockMutexError: BadContextError, BadIdError, WaitError, LockMutexPrecheckError { /// The mutex ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, /// The current task already owns the mutex. WouldDeadlock, /// The mutex was created with the protocol attribute having the value /// [`Ceiling`] and the current task's priority is higher than the /// mutex's priority ceiling. /// /// [`Ceiling`]: crate::kernel::MutexProtocol::Ceiling BadParam, /// The previous owning task exited while holding the mutex lock. *The /// current task shall hold the mutex lock*, but is up to make the /// state consistent. Abandoned, } } define_error! { mod lock_mutex_timeout_error {} /// Error type for [`Mutex::lock_timeout`]. /// /// [`Mutex::lock_timeout`]: super::Mutex::lock_timeout pub enum LockMutexTimeoutError: BadContextError, BadIdError, WaitTimeoutError, BadParamError, LockMutexPrecheckError { /// The mutex ID is out of range. BadId, /// CPU Lock is active, or the current context is not [waitable]. /// /// [waitable]: crate#contexts BadContext, Interrupted, Timeout, /// The current task already owns the mutex. WouldDeadlock, /// The timeout duration is negative, or the mutex was created with the /// protocol attribute having the value [`Ceiling`] and the current /// task's priority is higher than the mutex's priority ceiling. /// /// [`Ceiling`]: crate::kernel::MutexProtocol::Ceiling BadParam, /// The previous owning task exited while holding the mutex lock. *The /// current task shall hold the mutex lock*, but is up to make the /// state consistent. Abandoned, } } define_error! { mod mark_consistent_mutex_error {} /// Error type for [`Mutex::mark_consistent`]. /// /// [`Mutex::mark_consistent`]: super::Mutex::mark_consistent pub enum MarkConsistentMutexError: BadContextError, BadIdError { /// The mutex ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The mutex does not protect an inconsistent state. BadObjectState, } } define_error! { mod set_interrupt_line_priority_error {} /// Error type for [`InterruptLine::set_priority`] and /// [`InterruptLine::set_priority_unchecked`]. /// /// [`InterruptLine::set_priority`]: super::InterruptLine::set_priority /// [`InterruptLine::set_priority_unchecked`]: super::InterruptLine::set_priority_unchecked pub enum SetInterruptLinePriorityError: BadContextError, BadParamError { /// The operation is not supported by the port. NotSupported, /// CPU Lock is active, or the current context is not [a task context]. /// /// [a task context]: crate#contexts BadContext, /// The specified interrupt number or the specified priority value is /// out of range. BadParam, } } define_error! { mod enable_interrupt_line_error {} /// Error type for [`InterruptLine::enable`] and [`InterruptLine::disable`]. /// /// [`InterruptLine::enable`]: super::InterruptLine::enable /// [`InterruptLine::disable`]: super::InterruptLine::disable pub enum EnableInterruptLineError: BadParamError { /// The operation is not supported by the port. NotSupported, /// Enabling or disabling the specified interrupt line is not supported. BadParam, } } define_error! { mod pend_interrupt_line_error {} /// Error type for [`InterruptLine::pend`]. /// /// [`InterruptLine::pend`]: super::InterruptLine::pend pub enum PendInterruptLineError: BadParamError { /// Setting a pending flag is not supported by the port. NotSupported, /// Setting the pending flag of the specified interrupt line is not /// supported. BadParam, /// The interrupt line is not configured to allow this operation. For /// example, this operation is invalid for an level-triggered interrupt /// line. /// /// A port is not required to detect this condition. BadObjectState, } } define_error! { mod clear_interrupt_line_error {} /// Error type for [`InterruptLine::clear`]. /// /// [`InterruptLine::clear`]: super::InterruptLine::clear pub enum ClearInterruptLineError: BadParamError { /// Clearing a pending flag is not supported by the port. NotSupported, /// Clearing the pending flag of the specified interrupt line is not /// supported. BadParam, /// The interrupt line is not configured to allow this operation. For /// example, this operation is invalid for an level-triggered interrupt /// line. /// /// A port is not required to detect this condition. BadObjectState, } } define_error! { mod query_interrupt_line_error {} /// Error type for [`InterruptLine::is_pending`]. /// /// [`InterruptLine::is_pending`]: super::InterruptLine::is_pending pub enum QueryInterruptLineError: BadParamError { /// Reading a pending flag is not supported by the port. NotSupported, /// Reading the pending flag of the specified interrupt line is not /// supported. BadParam, } } define_error! { mod start_timer_error {} /// Error type for [`Timer::start`]. /// /// [`Timer::start`]: super::Timer::start pub enum StartTimerError: BadContextError, BadIdError { /// The timer ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod stop_timer_error {} /// Error type for [`Timer::stop`]. /// /// [`Timer::stop`]: super::Timer::stop pub enum StopTimerError: BadContextError, BadIdError { /// The timer ID is out of range. BadId, /// CPU Lock is active. BadContext, } } define_error! { mod set_timer_delay_error {} /// Error type for [`Timer::set_delay`]. /// /// [`Timer::set_delay`]: super::Timer::set_delay pub enum SetTimerDelayError: BadContextError, BadIdError, BadParamError { /// The timer ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The duration is negative. BadParam, } } define_error! { mod set_timer_period_error {} /// Error type for [`Timer::set_period`]. /// /// [`Timer::set_period`]: super::Timer::set_period pub enum SetTimerPeriodError: BadContextError, BadIdError, BadParamError { /// The timer ID is out of range. BadId, /// CPU Lock is active. BadContext, /// The duration is negative. BadParam, } }