1 /******************************************************************************
2 *  Filename:       smph_doc.h
3 *  Revised:        2016-03-30 13:03:59 +0200 (Wed, 30 Mar 2016)
4 *  Revision:       45971
5 *
6 *  Copyright (c) 2015 - 2020, Texas Instruments Incorporated
7 *  All rights reserved.
8 *
9 *  Redistribution and use in source and binary forms, with or without
10 *  modification, are permitted provided that the following conditions are met:
11 *
12 *  1) Redistributions of source code must retain the above copyright notice,
13 *     this list of conditions and the following disclaimer.
14 *
15 *  2) Redistributions in binary form must reproduce the above copyright notice,
16 *     this list of conditions and the following disclaimer in the documentation
17 *     and/or other materials provided with the distribution.
18 *
19 *  3) Neither the name of the ORGANIZATION nor the names of its contributors may
20 *     be used to endorse or promote products derived from this software without
21 *     specific prior written permission.
22 *
23 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 *  POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************/
36 //! \addtogroup mcusemaphore_api
37 //! @{
38 //! \section sec_mcusemaphore Introduction
39 //!
40 //! The MCU Semaphore offers 32 semaphores that each can be claimed and released in an atomic operation.
41 //! One and only one semaphore can be handled during a transaction.
42 //!
43 //! Claiming a semaphore causes subsequent claims/reads to return '0' (i.e. "not available").
44 //! How the semaphores are used and respected is decided by software.
45 //!
46 //! \section sec_mcusemaphore_api API
47 //!
48 //! The API functions can be grouped like this:
49 //!
50 //! Semaphore acquire:
51 //! - \ref SMPHAcquire()
52 //! - \ref SMPHTryAcquire()
53 //!
54 //! Semaphore release:
55 //! - \ref SMPHRelease()
56 //!
57 //! @}
58