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_notify 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 notify */
44 /* callback function call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* semaphore_ptr Pointer to semaphore */
49 /* semaphore_put_notify Application callback function */
50 /* (TX_NULL disables notify) */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Service return status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _tx_semaphore_put_notify Actual semaphore put notify */
59 /* call */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
70 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_txe_semaphore_put_notify(TX_SEMAPHORE * semaphore_ptr,VOID (* semaphore_put_notify)(TX_SEMAPHORE * notify_semaphore_ptr))74 UINT _txe_semaphore_put_notify(TX_SEMAPHORE *semaphore_ptr, VOID (*semaphore_put_notify)(TX_SEMAPHORE *notify_semaphore_ptr))
75 {
76
77 UINT status;
78
79
80 /* Check for an invalid semaphore pointer. */
81 if (semaphore_ptr == TX_NULL)
82 {
83
84 /* Semaphore pointer is invalid, return appropriate error code. */
85 status = TX_SEMAPHORE_ERROR;
86 }
87
88 /* Now check for invalid semaphore ID. */
89 else if (semaphore_ptr -> tx_semaphore_id != TX_SEMAPHORE_ID)
90 {
91
92 /* Semaphore pointer is invalid, return appropriate error code. */
93 status = TX_SEMAPHORE_ERROR;
94 }
95 else
96 {
97
98 /* Call actual semaphore put notify function. */
99 status = _tx_semaphore_put_notify(semaphore_ptr, semaphore_put_notify);
100 }
101
102 /* Return completion status. */
103 return(status);
104 }
105
106
