esif_sdk_iface.h

/*******************************************************************************
** This file is provided under a dual BSD/GPLv2 license.  When using or
** redistributing this file, you may do so under either license.
**
** GPL LICENSE SUMMARY
**
** Copyright (c) 2013-2023 Intel Corporation All Rights Reserved
**
** This program is free software; you can redistribute it and/or modify it under
** the terms of version 2 of the GNU General Public License as published by the
** Free Software Foundation.
**
** This program is distributed in the hope that it will be useful, but WITHOUT
** ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
** FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
** details.
**
** You should have received a copy of the GNU General Public License along with
** this program; if not, write to the Free Software  Foundation, Inc.,
** 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
** The full GNU General Public License is included in this distribution in the
** file called LICENSE.GPL.
**
** BSD LICENSE
**
** Copyright (c) 2013-2023 Intel Corporation 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 Intel Corporation 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.
**
*******************************************************************************/

#pragma once

#include "esif_sdk.h"


#include "esif_sdk_data.h"
#include "esif_sdk_domain_type.h"
#include "esif_sdk_participant_enum.h"
#include "esif_sdk_primitive_type.h"
#include "esif_ccb_rc.h"

/* Log Type */
typedef enum _t_eLogType {
	eLogTypeFatal   = 0,
	eLogTypeError   = 1,
	eLogTypeWarning = 2,
	eLogTypeInfo    = 3,
	eLogTypeDebug   = 4
} eLogType;

typedef enum _t_eIfaceType {
	eIfaceTypeApplication = 0,
	eIfaceTypeEsifService = 1,
	eIfaceTypeAction = 2,
	eIfaceTypeParticipant = 3,
	eIfaceTypeConjure = 4,
	eIfaceTypeConjureService =5,
	eIfaceTypeUnused06 = 6,
	eIfaceTypeIpfClient = 7,
	eIfaceTypeIpfIpc = 8,
} eIfaceType;

/* Header structure common to all ESIF interfaces */
typedef struct _t_EsifIfaceHdr {
	/* Interface */
	eIfaceType  fIfaceType; /* Inteface type: App, ESIF, action, etc. */
	UInt16      fIfaceVersion; /* Version of the given interface type */
	UInt16      fIfaceSize; /* Size of the whole structure including this header */
} EsifIfaceHdr, *EsifIfaceHdrPtr;


/* Application Interface */
struct _t_AppInterface;
typedef struct _t_AppInterface AppInterface, *AppInterfacePtr;

/* ESIF Interface */
struct _t_EsifInterface;
typedef struct _t_EsifInterface EsifInterface, *EsifInterfacePtr;

struct _t_AppInterfaceSet;
typedef struct _t_AppInterfaceSet AppInterfaceSet, *AppInterfaceSetPtr;

typedef enum esif_primitive_type	ePrimitiveType;
typedef enum esif_participant_enum	eParticipantBus;
typedef enum esif_domain_type		eDomainType;
typedef esif_flags_t			EsifFlags;