1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** ThreadX Component                                                     */
16 /**                                                                       */
17 /**   Semaphore                                                           */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 #define TX_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "tx_api.h"
28 #include "tx_semaphore.h"
29 
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _txe_semaphore_put                                  PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    William E. Lamie, Microsoft Corporation                             */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This function checks for errors in the semaphore put function call. */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    semaphore_ptr                     Pointer to semaphore control block*/
48 /*                                                                        */
49 /*  OUTPUT                                                                */
50 /*                                                                        */
51 /*    TX_SEMAPHORE_ERROR                Invalid semaphore pointer         */
52 /*    status                            Actual completion status          */
53 /*                                                                        */
54 /*  CALLS                                                                 */
55 /*                                                                        */
56 /*    _tx_semaphore_put                 Actual put semaphore function     */
57 /*                                                                        */
58 /*  CALLED BY                                                             */
59 /*                                                                        */
60 /*    Application Code                                                    */
61 /*                                                                        */
62 /*  RELEASE HISTORY                                                       */
63 /*                                                                        */
64 /*    DATE              NAME                      DESCRIPTION             */
65 /*                                                                        */
66 /*  05-19-2020     William E. Lamie         Initial Version 6.0           */
67 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
68 /*                                            resulting in version 6.1    */
69 /*                                                                        */
70 /**************************************************************************/
_txe_semaphore_put(TX_SEMAPHORE * semaphore_ptr)71 UINT  _txe_semaphore_put(TX_SEMAPHORE *semaphore_ptr)
72 {
73 
74 UINT        status;
75 
76 
77     /* Check for an invalid semaphore pointer.  */
78     if (semaphore_ptr == TX_NULL)
79     {
80 
81         /* Semaphore pointer is invalid, return appropriate error code.  */
82         status =  TX_SEMAPHORE_ERROR;
83     }
84 
85     /* Now check for invalid semaphore ID.  */
86     else if (semaphore_ptr -> tx_semaphore_id != TX_SEMAPHORE_ID)
87     {
88 
89         /* Semaphore pointer is invalid, return appropriate error code.  */
90         status =  TX_SEMAPHORE_ERROR;
91     }
92     else
93     {
94 
95         /* Call actual put semaphore function.  */
96         status =  _tx_semaphore_put(semaphore_ptr);
97     }
98 
99     /* Return completion status.  */
100     return(status);
101 }
102 
103