Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit baf71316 authored by Lina Iyer's avatar Lina Iyer
Browse files

drivers: qcom: rpmh: add RPMH utility functions for TCS communication 



Drivers that communicate with the TCS mailbox driver duplicate the same
functionality in managing memory for requests, threaded handling of
completion responses etc. Collect all such common functionality into a
simple set of API that abstracts complexity and optimizations in
communication with the mailbox controller.

The key benefits of using this API instead of directly using mailbox API
for QTI drivers are -
	* Caching of sleep and wake requests
	* Handling of completion callbacks
	* Memory management to avoid fragmenting kernel memory
	* Batch processing of requests

This is a snapshot as of 'commit b4a69c05b01172 ("drivers: mailbox:
rpmh-mailbox: rename file to match convention")'.

Change-Id: Id80b9312ff14537f9732acfa090f8e997158b63a
Signed-off-by: default avatarLina Iyer <ilina@codeaurora.org>
parent 61555831

drivers/soc/qcom/Kconfig

+8 −0
Original line number Diff line number Diff line
@@ -304,3 +304,11 @@ config QCOM_COMMAND_DB 
	help

	  Command DB queries shared memory by key string for shared system

	  resources



config QTI_RPMH_API

	bool "QTI RPMH (h/w accelerators) Communication API"

	select MAILBOX

	select QTI_RPMH_MBOX

	help

	  This option enables RPMH hardware communication for making shared

	  resource requests on Qualcomm Technologies Inc SoCs.

drivers/soc/qcom/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ obj-$(CONFIG_MSM_PIL_SSR_GENERIC) += subsys-pil-tz.o 
obj-$(CONFIG_MSM_PIL)   +=      peripheral-loader.o

obj-$(CONFIG_QCOM_BUS_SCALING) += msm_bus/

obj-$(CONFIG_QCOM_COMMAND_DB) += cmd-db.o

obj-$(CONFIG_QTI_RPMH_API) += rpmh.o



ifdef CONFIG_MSM_SUBSYSTEM_RESTART

       obj-y += subsystem_notif.o

drivers/soc/qcom/rpmh.c

0 → 100644
+1126 −0

File added.

Preview size limit exceeded, changes collapsed.

include/soc/qcom/rpmh.h

0 → 100644
+108 −0
Original line number Diff line number Diff line 
/* Copyright (c) 2016-2017, The Linux Foundation. All rights reserved.

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 and

 * only version 2 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.

 *

 */

#ifndef __SOC_QCOM_RPMH_H__

#define __SOC_QCOM_RPMH_H__



#include <soc/qcom/tcs.h>

#include <linux/platform_device.h>



struct rpmh_client;



#ifdef CONFIG_QTI_RPMH_API

int rpmh_write_single(struct rpmh_client *rc, enum rpmh_state state,

			u32 addr, u32 data);



int rpmh_write_single_async(struct rpmh_client *rc,

			enum rpmh_state state, u32 addr, u32 data);



int rpmh_write(struct rpmh_client *rc, enum rpmh_state state,

			struct tcs_cmd *cmd, int n);



int rpmh_write_async(struct rpmh_client *rc, enum rpmh_state state,

			struct tcs_cmd *cmd, int n);



int rpmh_write_batch(struct rpmh_client *rc, enum rpmh_state state,

			struct tcs_cmd *cmd, int *n);



int rpmh_mode_solver_set(struct rpmh_client *rc, bool enable);



int rpmh_write_control(struct rpmh_client *rc, struct tcs_cmd *cmd, int n);



int rpmh_invalidate(struct rpmh_client *rc);



int rpmh_ctrlr_idle(struct rpmh_client *rc);



int rpmh_flush(struct rpmh_client *rc);



int rpmh_read(struct rpmh_client *rc, u32 addr, u32 *resp);



struct rpmh_client *rpmh_get_byname(struct platform_device *pdev,

			const char *name);



struct rpmh_client *rpmh_get_byindex(struct platform_device *pdev,

			int index);



void rpmh_release(struct rpmh_client *rc);

#else

static inline int rpmh_write_single(struct rpmh_client *rc,

			enum rpmh_state state, u32 addr, u32 data)

{ return -ENODEV; }



static inline int rpmh_write_single_async(struct rpmh_client *rc,

			enum rpmh_state state, u32 addr, u32 data)

{ return -ENODEV; }



static inline int rpmh_write(struct rpmh_client *rc, enum rpmh_state state,

			struct tcs_cmd *cmd, int n)

{ return -ENODEV; }



static inline int rpmh_write_async(struct rpmh_client *rc,

			enum rpmh_state state, struct tcs_cmd *cmd, int n)

{ return -ENODEV; }



static inline int rpmh_write_batch(struct rpmh_client *rc,

			enum rpmh_state state, struct tcs_cmd *cmd, int *n)

{ return -ENODEV; }



static inline int rpmh_mode_solver_set(struct rpmh_client *rc, bool enable)

{ return -ENODEV; }



static inline int rpmh_write_control(struct rpmh_client *rc,

			struct tcs_cmd *cmd, int n)

{ return -ENODEV; }



static inline int rpmh_invalidate(struct rpmh_client *rc)

{ return -ENODEV; }



static inline int rpmh_ctrlr_idle(struct rpmh_client *rc)

{ return -ENODEV; }



static inline int rpmh_flush(struct rpmh_client *rc)

{ return -ENODEV; }



static inline int rpmh_read(struct rpmh_client *rc, u32 addr,

			u32 *resp)

{ return -ENODEV; }



static inline struct rpmh_client *rpmh_get_byname(struct platform_device *pdev,

			const char *name)

{ return ERR_PTR(-ENODEV); }



static inline struct rpmh_client *rpmh_get_byindex(struct platform_device *pdev,

			int index)

{ return ERR_PTR(-ENODEV); }



static inline void rpmh_release(struct rpmh_client *rc) { }

#endif /* CONFIG_QTI_RPMH_API */



#endif /* __SOC_QCOM_RPMH_H__ */