TI-RTOS Drivers  tidrivers_full_2_20_00_08
MutexP.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
55 #ifndef ti_drivers_ports_MutexP__include
56 #define ti_drivers_ports_MutexP__include
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 #include <stdint.h>
63 #include <stdbool.h>
64 #include <stddef.h>
65 
69 typedef enum MutexP_Status {
71  MutexP_OK = 0,
75 
83 typedef void *MutexP_Handle;
84 
94 typedef struct MutexP_Params {
95  char *name;
98 
99 
109 extern MutexP_Handle MutexP_create(MutexP_Params *params);
110 
120 extern MutexP_Status MutexP_delete(MutexP_Handle handle);
121 
130 extern void MutexP_Params_init(MutexP_Params *params);
131 
149 extern uintptr_t MutexP_lock(MutexP_Handle handle);
150 
169 extern void MutexP_unlock(MutexP_Handle handle, uintptr_t key);
170 
171 #ifdef __cplusplus
172 }
173 #endif
174 
175 #endif /* ti_drivers_ports_MutexP__include */
char * name
Definition: MutexP.h:95
void * MutexP_Handle
Opaque client reference to an instance of a MutexP.
Definition: MutexP.h:83
Definition: MutexP.h:73
Definition: MutexP.h:71
uintptr_t MutexP_lock(MutexP_Handle handle)
Function to lock a mutex.
struct MutexP_Params MutexP_Params
Basic MutexP Parameters.
void MutexP_Params_init(MutexP_Params *params)
Initialize params structure to default values.
MutexP_Handle MutexP_create(MutexP_Params *params)
Function to create a mutex.
MutexP_Status MutexP_delete(MutexP_Handle handle)
Function to delete a mutex.
void MutexP_unlock(MutexP_Handle handle, uintptr_t key)
Function to unlock a mutex.
Basic MutexP Parameters.
Definition: MutexP.h:94
MutexP_Status
Status codes for MutexP APIs.
Definition: MutexP.h:69
Copyright 2016, Texas Instruments Incorporated