- Timestamp:
- 08/22/14 15:09:36 (10 years ago)
- Branches:
- 4.11, 5, master
- Children:
- 9907dde
- Parents:
- 8f1bdcb9
- git-author:
- Sebastian Huber <sebastian.huber@…> (08/22/14 15:09:36)
- git-committer:
- Sebastian Huber <sebastian.huber@…> (08/26/14 08:21:27)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user/clock.t
r8f1bdcb9 r96ec8ee8 22 22 @item @code{@value{DIRPREFIX}clock_get_ticks_per_second} - Get ticks per second 23 23 @item @code{@value{DIRPREFIX}clock_get_ticks_since_boot} - Get current ticks counter value 24 @item @code{@value{DIRPREFIX}clock_tick_later} - Get tick value in the future 25 @item @code{@value{DIRPREFIX}clock_tick_later_usec} - Get tick value in the future in microseconds 26 @item @code{@value{DIRPREFIX}clock_tick_before} - Is tick value is before a point in time 24 27 @item @code{@value{DIRPREFIX}clock_get_uptime} - Get time since boot 25 28 @item @code{@value{DIRPREFIX}clock_get_uptime_timeval} - Get time since boot in timeval format … … 618 621 @c 619 622 @page 623 @subsection CLOCK_TICK_LATER - Get tick value in the future 624 625 @subheading CALLING SEQUENCE: 626 627 @ifset is-C 628 @findex rtems_clock_tick_later 629 @example 630 rtems_interval rtems_clock_tick_later( 631 rtems_interval delta 632 ); 633 @end example 634 @end ifset 635 636 @subheading DESCRIPTION: 637 638 Returns the ticks counter value delta ticks in the future. 639 640 @subheading NOTES: 641 642 This directive is callable from an ISR. 643 644 This directive will not cause the running task to be preempted. 645 646 @c 647 @c 648 @c 649 @page 650 @subsection CLOCK_TICK_LATER_USEC - Get tick value in the future in microseconds 651 652 @subheading CALLING SEQUENCE: 653 654 @ifset is-C 655 @findex rtems_clock_tick_later_usec 656 @example 657 rtems_interval rtems_clock_tick_later_usec( 658 rtems_interval delta_in_usec 659 ); 660 @end example 661 @end ifset 662 663 @subheading DESCRIPTION: 664 665 Returns the ticks counter value at least delta microseconds in the future. 666 667 @subheading NOTES: 668 669 This directive is callable from an ISR. 670 671 This directive will not cause the running task to be preempted. 672 673 @c 674 @c 675 @c 676 @page 677 @subsection CLOCK_TICK_BEFORE - Is tick value is before a point in time 678 679 @subheading CALLING SEQUENCE: 680 681 @ifset is-C 682 @findex rtems_clock_tick_before 683 @example 684 rtems_interval rtems_clock_tick_before( 685 rtems_interval tick 686 ); 687 @end example 688 @end ifset 689 690 @subheading DESCRIPTION: 691 692 Returns true if the current ticks counter value indicates a time before the 693 time specified by the tick value and false otherwise. 694 695 @subheading NOTES: 696 697 This directive is callable from an ISR. 698 699 This directive will not cause the running task to be preempted. 700 701 @subheading EXAMPLE: 702 703 @example 704 @group 705 status busy( void ) 706 @{ 707 rtems_interval timeout = rtems_clock_tick_later_usec( 10000 ); 708 709 do @{ 710 if ( ok() ) @{ 711 return success; 712 @} 713 @} while ( rtems_clock_tick_before( timeout ) ); 714 715 return timeout; 716 @} 717 @end group 718 @end example 719 720 @c 721 @c 722 @c 723 @page 620 724 @subsection CLOCK_GET_UPTIME - Get the time since boot 621 725
Note: See TracChangeset
for help on using the changeset viewer.