Notify.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2013, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_ipc_Notify__include
#define ti_ipc_Notify__include

#if defined (__cplusplus)
extern "C" {
#endif

/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */

#define Notify_S_BUSY                    2

#define Notify_S_ALREADYSETUP            1

#define Notify_S_SUCCESS                 0

#define Notify_E_FAIL                   -1

#define Notify_E_INVALIDARG             -2

#define Notify_E_MEMORY                 -3

#define Notify_E_ALREADYEXISTS          -4

#define Notify_E_NOTFOUND               -5

#define Notify_E_TIMEOUT                -6

#define Notify_E_INVALIDSTATE           -7

#define Notify_E_OSFAILURE              -8

#define Notify_E_ALREADYSETUP           -9

#define Notify_E_RESOURCE               -10

#define Notify_E_RESTART                -11

#define Notify_E_BUSY                   -12

#define Notify_E_DRIVERNOTREGISTERED    -13

#define Notify_E_EVTNOTREGISTERED       -14

#define Notify_E_EVTDISABLED            -15

#define Notify_E_NOTINITIALIZED         -16

#define Notify_E_EVTRESERVED            -17

/* =============================================================================
 *  Macros
 * =============================================================================
 */

#define Notify_MAXEVENTS                (UInt16)32

#define Notify_MAX_INTLINES             4u

#define Notify_SYSTEMKEY                ((UInt16)0xC1D2)

/* =============================================================================
 *  Structures & Enums
 * =============================================================================
 */

typedef Void (*Notify_FnNotifyCbck)(UInt16 , UInt16, UInt32, UArg, UInt32);

/* =============================================================================
 *  Notify Module-wide Functions
 * =============================================================================
 */

Int Notify_attach(UInt16 remoteProcId, Ptr sharedAddr);

UInt Notify_disable(UInt16 procId, UInt16 lineId);

Void Notify_disableEvent(UInt16 procId, UInt16 lineId, UInt32 eventId);

Void Notify_enableEvent(UInt16 procId, UInt16 lineId, UInt32 eventId);

Bool Notify_eventAvailable(UInt16 procId, UInt16 lineId, UInt32 eventId);

Bool Notify_intLineRegistered(UInt16 procId, UInt16 lineId);

UInt16 Notify_numIntLines(UInt16 procId);

SizeT Notify_sharedMemReq(UInt16 procId, Ptr sharedAddr);

Int Notify_registerEvent(UInt16 procId,
                         UInt16 lineId,
                         UInt32 eventId,
                         Notify_FnNotifyCbck fnNotifyCbck,
                         UArg cbckArg);

Int Notify_registerEventSingle(UInt16 procId,
                               UInt16 lineId,
                               UInt32 eventId,
                               Notify_FnNotifyCbck fnNotifyCbck,
                               UArg cbckArg);

Void Notify_restore(UInt16 procId, UInt16 lineId, UInt key);

Int Notify_sendEvent(UInt16 procId, UInt16 lineId, UInt32 eventId,
        UInt32 payload, Bool waitClear);

Int Notify_unregisterEvent(UInt16 procId, UInt16 lineId, UInt32 eventId,
        Notify_FnNotifyCbck fnNotifyCbck, UArg cbckArg);

Int Notify_unregisterEventSingle(UInt16 procId, UInt16 lineId, UInt32 eventId);

#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */
#endif /* ti_ipc_Notify__include */