Changeset eecec5f in rtems-docs


Ignore:
Timestamp:
Jul 14, 2017, 5:52:21 AM (2 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11
Children:
ba143e0
Parents:
e9b193a
git-author:
Sebastian Huber <sebastian.huber@…> (07/14/17 05:52:21)
git-committer:
Sebastian Huber <sebastian.huber@…> (07/14/17 05:55:26)
Message:

c-user: Fix interrupt lock documentation

Close #3075.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • c-user/interrupt_manager.rst

    re9b193a reecec5f  
    495495
    496496        void rtems_interrupt_lock_initialize(
    497             rtems_interrupt_lock *lock
    498         );
    499 
    500 DIRECTIVE STATUS CODES:
    501     NONE
    502 
    503 DESCRIPTION:
    504     Initializes an interrupt lock.
     497            rtems_interrupt_lock *lock,
     498            const char           *name
     499        );
     500
     501DIRECTIVE STATUS CODES:
     502    NONE
     503
     504DESCRIPTION:
     505    Initializes an interrupt lock.  The name must be persistent throughout the
     506    lifetime of the lock.
    505507
    506508NOTES:
     
    521523
    522524        void rtems_interrupt_lock_acquire(
    523             rtems_interrupt_lock *lock,
    524             rtems_interrupt_level level
     525            rtems_interrupt_lock         *lock,
     526            rtems_interrupt_lock_context *lock_context
    525527        );
    526528
     
    533535
    534536NOTES:
     537    A separate lock context must be provided for each acquire/release pair, for
     538    example an automatic variable.
     539
     540    An attempt to recursively acquire the lock may result in an infinite loop
     541    with interrupts disabled.
     542
    535543    This directive will not cause the calling thread to be preempted.  This
    536544    directive can be used in thread and interrupt context.
     
    550558
    551559        void rtems_interrupt_lock_release(
    552             rtems_interrupt_lock *lock,
    553             rtems_interrupt_level level
     560            rtems_interrupt_lock         *lock,
     561            rtems_interrupt_lock_context *lock_context
    554562        );
    555563
     
    562570
    563571NOTES:
     572    The lock context must be the one used to acquire the lock, otherwise the
     573    result is unpredictable.
     574
    564575    This directive will not cause the calling thread to be preempted.  This
    565576    directive can be used in thread and interrupt context.
     
    579590
    580591        void rtems_interrupt_lock_acquire_isr(
    581             rtems_interrupt_lock *lock,
    582             rtems_interrupt_level level
     592            rtems_interrupt_lock         *lock,
     593            rtems_interrupt_lock_context *lock_context
    583594        );
    584595
     
    589600    The interrupt status will remain unchanged.  On SMP configurations this
    590601    directive acquires a SMP lock.
     602
     603NOTES:
     604    A separate lock context must be provided for each acquire/release pair, for
     605    example an automatic variable.
     606
     607    An attempt to recursively acquire the lock may result in an infinite loop.
     608
     609    This directive is intended for device drivers and should be called from the
     610    corresponding interrupt service routine.
    591611
    592612    In case the corresponding interrupt service routine can be interrupted by
     
    594614    protected by this lock, then the result is unpredictable.
    595615
    596 NOTES:
    597     This directive should be called from the corresponding interrupt service
    598     routine.
    599 
    600616.. raw:: latex
    601617
     
    612628
    613629        void rtems_interrupt_lock_release_isr(
    614             rtems_interrupt_lock *lock,
    615             rtems_interrupt_level level
    616         );
    617 
    618 DIRECTIVE STATUS CODES:
    619     NONE
    620 
    621 DESCRIPTION:
    622 
    623     The interrupt status will remain unchanged.  On SMP configurations this
    624     directive releases a SMP lock.
    625 
    626 NOTES:
    627     This directive should be called from the corresponding interrupt service
    628     routine.
     630            rtems_interrupt_lock         *lock,
     631            rtems_interrupt_lock_context *lock_context
     632        );
     633
     634DIRECTIVE STATUS CODES:
     635    NONE
     636
     637DESCRIPTION:
     638    The interrupt status will remain unchanged.  In SMP configurations, this
     639    directive releases an SMP lock.
     640
     641NOTES:
     642    The lock context must be the one used to acquire the lock, otherwise the
     643    result is unpredictable.
     644
     645    This directive is intended for device drivers and should be called from the
     646    corresponding interrupt service routine.
    629647
    630648.. raw:: latex
Note: See TracChangeset for help on using the changeset viewer.