iPNIsoMDrv.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef IPNISOMDRV_H_
#define IPNISOMDRV_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/* ========================================================================== */
/*                          Doxygen                                           */
/* ========================================================================== */
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include "PN_Handle.h"
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define PNISO_MAX_NUM_EVENTS        2
 
#define PNISO_MODE_NONE             0
 
#define PNISO_MODE_INTERRUPT        1
 
#define PNISO_MODE_GPIO             2
 
#define PNISO_MODE_DISABLE          0
 
#define PNISO_MODE_ENABLE           1
 
#define PNISO_TI_EVENT              1
 
#define PNISO_TI_EVENT_REG_SHIFT       0
 
#define PNISO_TO_EVENT              2
 
#define PNISO_TO_EVENT_REG_SHIFT       1
 
/* ========================================================================== */
/*                         Error Types                                        */
/* ========================================================================== */
 
#define PNISO_ERR_SUCCESS                  0
#define PNISO_ERR_INVALID_EVENT           -1
#define PNISO_ERR_EVENTS_EXHAUSTED         -2
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void PN_event1IsrHandler(void *arg);
 
void PN_event2IsrHandler(void *arg);
 
int8_t PN_ISO_initGPIOEvent(PN_Handle pnHandle, uint8_t isoMode, uint8_t isoEvent, uint32_t timeval, uint32_t duration);
void PN_ISO_enableGPIOEvent(PN_Handle pnHandle);
void PN_ISO_disableGPIOEvent(PN_Handle pnHandle);
void PN_ISO_deInitGPIOEvent(PN_Handle pnHandle);
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPNISOMDRV_H_ */