AM243x INDUSTRIAL COMMUNICATIONS SDK  09.02.00
iPNIsoMDrv.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * 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
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef IPNISOMDRV_H_
34 #define IPNISOMDRV_H_
35 
36 #ifdef __cplusplus
37 extern "C"
38 {
39 #endif
40 
41 
42 /* ========================================================================== */
43 /* Doxygen */
44 /* ========================================================================== */
50 /* ========================================================================== */
51 /* Include Files */
52 /* ========================================================================== */
53 
54 #include "PN_Handle.h"
55 
56 /* ========================================================================== */
57 /* Macros & Typedefs */
58 /* ========================================================================== */
59 
65 #define PNISO_MAX_NUM_EVENTS 2
66 
72 #define PNISO_MODE_NONE 0
73 
81 #define PNISO_MODE_INTERRUPT 1
82 
86 #define PNISO_MODE_GPIO 2
87 
91 #define PNISO_MODE_DISABLE 0
92 
96 #define PNISO_MODE_ENABLE 1
97 
101 typedef uint32_t * PNISOM_Handle;
102 
103 /* ========================================================================== */
104 /* Function Declarations */
105 /* ========================================================================== */
117 PNISOM_Handle PN_ISO_initGPIOEvent(PN_Handle pnHandle, uint8_t isoMode, uint32_t timeval, uint32_t duration);
142 
147 #ifdef __cplusplus
148 }
149 #endif
150 
151 #endif /* IPNISOMDRV_H_ */
PN_ISO_deInitGPIOEvent
void PN_ISO_deInitGPIOEvent(PN_Handle pnHandle, PNISOM_Handle isoHandle)
API to De init the ISOM event/signal.
PN_Handle
struct PN_Config_s * PN_Handle
Alias for Profinet Handle containing base addresses and modules.
Definition: PN_Handle.h:102
PN_ISO_enableGPIOEvent
void PN_ISO_enableGPIOEvent(PN_Handle pnHandle, PNISOM_Handle isoHandle)
API to enable the ISOM event/signal generation.
PN_Handle.h
PN_ISO_initGPIOEvent
PNISOM_Handle PN_ISO_initGPIOEvent(PN_Handle pnHandle, uint8_t isoMode, uint32_t timeval, uint32_t duration)
API to initialize the ISOM event/signal. Returns the ISOM handle. The Event/signal will be disabled b...
PN_ISO_disableGPIOEvent
void PN_ISO_disableGPIOEvent(PN_Handle pnHandle, PNISOM_Handle isoHandle)
API to disable the ISOM event/signal generation.
PNISOM_Handle
uint32_t * PNISOM_Handle
ISOM handle.
Definition: iPNIsoMDrv.h:101