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

Commit 754a8023 authored by Konstantin Dorfman's avatar Konstantin Dorfman
Browse files

soc: qcom: add secure processor communication (spcom) driver 



This driver supports communication with secure processor subsystem
over rpmsg and ungerlying glink transport layer.
The communication is based on using shared memory and interrupts.
This driver exposes interface to user space.

Migrate from using glink api to rpmsg api:
- removed not used glink functionality
- removed not used kernel api to spcom functionality
- implemented rpmsg driver registration for each new spcom channel
open/close/tx/rx/poll flows fixes:
- rpmsg_abort flag introduced to synchronize close() of a channel with
  pending sending or receiving data from the channel
- tx implemented as rpmsg_trysend() every 10ms (timeout_msec total)
- poll imlemented link up/down events as first/last rpmsg device
  probed/removed
- locking

ION api replaced by dma-buf:
ION api depricated.
This change implements following functionality:
Lock/unlock shared buffer by reference counting on underline dma-buf.
Translation user allocated shared buffer virtual address to
physical address (to enable SPU access to the buffer).

Change-Id: I28d704b18a3b0de9711ff3235c3f5551e7302557
Signed-off-by: default avatarKonstantin Dorfman <kdorfman@codeaurora.org>
parent 4cec0cd6

Documentation/devicetree/bindings/arm/msm/spcom.txt

0 → 100644
+11 −0
Original line number Diff line number Diff line 
Qualcomm Technologies, Inc. Secure Proccessor Communication (spcom)



Required properties:

-compatible : should be "qcom,spcom"

-qcom,spcom-ch-names: predefined channels name string



Example:

    qcom,spcom {

            compatible = "qcom,spcom";

            qcom,spcom-ch-names = "sp_kernel" , "sp_ssr";

    };

drivers/soc/qcom/Kconfig

+13 −0
Original line number Diff line number Diff line
@@ -432,6 +432,19 @@ config MSM_SPSS_UTILS 
	  because the SPSS firmware size is too small to support multiple

	  HW versions.



config MSM_SPCOM

	depends on QCOM_GLINK

	bool "Secure Processor Communication over GLINK"

	help

	  spcom driver allows loading Secure Processor Applications and

	  sending messages to Secure Processor Applications.

	  spcom provides interface to both user space app and kernel driver.

	  It is using glink as the transport layer, which provides multiple

	  logical channels over single physical channel.

	  The physical layer is based on shared memory and interrupts.

	  spcom provides clients/server API, although currently only one client

	  or server is allowed per logical channel.



config QTI_RPMH_API

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

	select MAILBOX

drivers/soc/qcom/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -43,6 +43,7 @@ obj-$(CONFIG_MEM_SHARE_QMI_SERVICE) += memshare/ 
obj-$(CONFIG_MSM_PIL_SSR_GENERIC) += subsys-pil-tz.o

obj-$(CONFIG_MSM_PIL)   +=      peripheral-loader.o

obj-$(CONFIG_QCOM_RUN_QUEUE_STATS) += rq_stats.o

obj-$(CONFIG_MSM_SPCOM) += spcom.o

obj-$(CONFIG_QCOM_BUS_SCALING) += msm_bus/

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

obj-$(CONFIG_QTI_RPMH_API) += rpmh.o

drivers/soc/qcom/spcom.c

0 → 100644
+2093 −0

File added.

Preview size limit exceeded, changes collapsed.

include/uapi/linux/spcom.h

0 → 100644
+119 −0
Original line number Diff line number Diff line 
/* Copyright (c) 2015-2018, 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 _UAPI_SPCOM_H_

#define _UAPI_SPCOM_H_



#include <linux/types.h>	/* uint32_t, bool */

#ifndef BIT

	#define BIT(x) (1 << x)

#endif



#ifndef PAGE_SIZE

	#define PAGE_SIZE 4096

#endif



/**

 * @brief - Secure Processor Communication interface to user space spcomlib.

 *

 * Sending data and control commands by write() file operation.

 * Receiving data by read() file operation.

 * Getting the next request size by read() file operation,

 * with special size SPCOM_GET_NEXT_REQUEST_SIZE.

 */



/*

 * Maximum number of channel between Secure Processor and HLOS.

 * including predefined channels, like "sp_kernel".

 */

#define SPCOM_MAX_CHANNELS	0x20



/* Maximum size (including null) for channel names */

#define SPCOM_CHANNEL_NAME_SIZE		32

/*

 * file read(fd, buf, size) with this size,

 * hints the kernel that user space wants to read the next-req-size.

 * This size is bigger than both SPCOM_MAX_REQUEST_SIZE and

 * SPCOM_MAX_RESPONSE_SIZE , so it is not a valid data size.

 */

#define SPCOM_GET_NEXT_REQUEST_SIZE	(PAGE_SIZE-1)



/* Command Id between spcomlib and spcom driver, on write() */

enum spcom_cmd_id {

	SPCOM_CMD_LOAD_APP	= 0x4C4F4144, /* "LOAD" = 0x4C4F4144 */

	SPCOM_CMD_RESET_SP	= 0x52455354, /* "REST" = 0x52455354 */

	SPCOM_CMD_SEND		= 0x53454E44, /* "SEND" = 0x53454E44 */

	SPCOM_CMD_SEND_MODIFIED	= 0x534E444D, /* "SNDM" = 0x534E444D */

	SPCOM_CMD_LOCK_ION_BUF  = 0x4C4F434B, /* "LOCK" = 0x4C4F434B */

	SPCOM_CMD_UNLOCK_ION_BUF = 0x554C434B, /* "ULCK" = 0x4C4F434B */

	SPCOM_CMD_FSSR		= 0x46535352, /* "FSSR" = 0x46535352 */

	SPCOM_CMD_CREATE_CHANNEL = 0x43524554, /* "CRET" = 0x43524554 */

};



/*

 * @note: Event types that are always implicitly polled:

 * POLLERR=0x08 | POLLHUP=0x10 | POLLNVAL=0x20

 * so bits 3,4,5 can't be used

 */

enum spcom_poll_events {

	SPCOM_POLL_LINK_STATE	= BIT(1),

	SPCOM_POLL_CH_CONNECT	= BIT(2),

	SPCOM_POLL_READY_FLAG	= BIT(14), /* output */

	SPCOM_POLL_WAIT_FLAG	= BIT(15), /* if set , wait for the event */

};



/* Common Command structure between User Space and spcom driver, on write() */

struct spcom_user_command {

	enum spcom_cmd_id cmd_id;

	uint32_t arg;

} __packed;



/* Command structure between User Space and spcom driver, on write() */

struct spcom_send_command {

	enum spcom_cmd_id cmd_id;

	uint32_t timeout_msec;

	uint32_t buf_size;

	char buf[0]; /* Variable buffer size - must be last field */

} __packed;



/* Command structure between userspace spcomlib and spcom driver, on write() */

struct spcom_user_create_channel_command {

	enum spcom_cmd_id cmd_id;

	char ch_name[SPCOM_CHANNEL_NAME_SIZE];

} __packed;



/* maximum ION buf for send-modfied-command */

#define SPCOM_MAX_ION_BUF 4



struct spcom_ion_info {

	int32_t fd; /* ION buffer File Descriptor, set -1 for invalid fd */

	uint32_t buf_offset; /* virtual address offset in request/response */

};



/* Pass this FD to unlock all ION buffer for the specific channel */

#define SPCOM_ION_FD_UNLOCK_ALL	0xFFFF



struct spcom_ion_handle {

	int32_t fd;		/* File Descriptor associated with the buffer */

};



/* Command structure between User Space and spcom driver, on write() */

struct spcom_user_send_modified_command {

	enum spcom_cmd_id cmd_id;

	struct spcom_ion_info ion_info[SPCOM_MAX_ION_BUF];

	uint32_t timeout_msec;

	uint32_t buf_size;

	char buf[0]; /* Variable buffer size - must be last field */

} __packed;





#endif /* _UAPI_SPCOM_H_ */