mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-08-15 08:57:02 +02:00
c3cf06f1a3
All identifiers, regardless of use, that start with two underscores are reserved. This means they can't be used in header guards. The style that this project is now to use the full name of the file in capital letters followed by 'H'. For example, for a file called "uart_example.h", the header guard is UART_EXAMPLE_H. The exceptions are files that are imported from other projects: - CryptoCell driver - dt-bindings folders - zlib headers Change-Id: I50561bf6c88b491ec440d0c8385c74650f3c106e Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
68 lines
1.5 KiB
C
68 lines
1.5 KiB
C
/*
|
|
* Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
/*!
|
|
* Header file for the IPC implementation.
|
|
*/
|
|
|
|
#ifndef SCI_IPC_H
|
|
#define SCI_IPC_H
|
|
|
|
/* Includes */
|
|
|
|
#include <sci/sci_types.h>
|
|
|
|
/* Defines */
|
|
|
|
/* Types */
|
|
|
|
/* Functions */
|
|
|
|
/*!
|
|
* This function opens an IPC channel.
|
|
*
|
|
* @param[out] ipc return pointer for ipc handle
|
|
* @param[in] id id of channel to open
|
|
*
|
|
* @return Returns an error code (SC_ERR_NONE = success, SC_ERR_IPC
|
|
* otherwise).
|
|
*
|
|
* The \a id parameter is implementation specific. Could be an MU
|
|
* address, pointer to a driver path, channel index, etc.
|
|
*/
|
|
sc_err_t sc_ipc_open(sc_ipc_t *ipc, sc_ipc_id_t id);
|
|
|
|
/*!
|
|
* This function closes an IPC channel.
|
|
*
|
|
* @param[in] ipc id of channel to close
|
|
*/
|
|
void sc_ipc_close(sc_ipc_t ipc);
|
|
|
|
/*!
|
|
* This function reads a message from an IPC channel.
|
|
*
|
|
* @param[in] ipc id of channel read from
|
|
* @param[out] data pointer to message buffer to read
|
|
*
|
|
* This function will block if no message is available to be read.
|
|
*/
|
|
void sc_ipc_read(sc_ipc_t ipc, void *data);
|
|
|
|
/*!
|
|
* This function writes a message to an IPC channel.
|
|
*
|
|
* @param[in] ipc id of channel to write to
|
|
* @param[in] data pointer to message buffer to write
|
|
*
|
|
* This function will block if the outgoing buffer is full.
|
|
*/
|
|
void sc_ipc_write(sc_ipc_t ipc, void *data);
|
|
|
|
sc_ipc_t ipc_handle;
|
|
|
|
#endif /* SCI_IPC_H */
|