diff options
Diffstat (limited to 'include/soc/imx8/sc/ipc.h')
-rw-r--r-- | include/soc/imx8/sc/ipc.h | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/include/soc/imx8/sc/ipc.h b/include/soc/imx8/sc/ipc.h new file mode 100644 index 000000000000..d87f9189fba3 --- /dev/null +++ b/include/soc/imx8/sc/ipc.h @@ -0,0 +1,71 @@ +/* + * Copyright (C) 2016 Freescale Semiconductor, Inc. + * Copyright 2017 NXP + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +/*! + * Header file for the IPC implementation. + */ + +#ifndef _SC_IPC_H +#define _SC_IPC_H + +/* Includes */ + +#include <linux/thermal.h> +#include <soc/imx8/sc/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); + +int register_scu_notifier(struct notifier_block *nb); +int unregister_scu_notifier(struct notifier_block *nb); + +#endif /* _SC_IPC_H */ + |