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

Commit ce8c891c authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'rproc-v4.8' of git://github.com/andersson/remoteproc 

Pull remoteproc updates from Bjorn Andersson:
 "Introduce remoteproc driver for controlling the modem/DSP Hexagon CPU
  found in a multitude of Qualcomm platform.

  Also cleans up a race condition/potential leak during registration of
  remoteprocs and includes devicetree bindings in the MAINTAINERS entry"

* tag 'rproc-v4.8' of git://github.com/andersson/remoteproc:
  remoteproc: qcom: hexagon: Clean up mpss validation
  remoteproc: qcom: remove redundant dev_err call in q6v5_init_mem()
  remoteproc: qcom: Driver for the self-authenticating Hexagon v5
  dt-binding: remoteproc: Introduce Hexagon loader binding
  remoteproc: Fix potential race condition in rproc_add
  MAINTAINERS: Add file patterns for remoteproc device tree bindings
parents 10eec60c 72beb490

Documentation/devicetree/bindings/remoteproc/qcom,q6v5.txt

0 → 100644
+137 −0
Original line number Diff line number Diff line 
Qualcomm Hexagon Peripheral Image Loader



This document defines the binding for a component that loads and boots firmware

on the Qualcomm Hexagon core.



- compatible:

	Usage: required

	Value type: <string>

	Definition: must be one of:

		    "qcom,q6v5-pil"



- reg:

	Usage: required

	Value type: <prop-encoded-array>

	Definition: must specify the base address and size of the qdsp6 and

		    rmb register blocks



- reg-names:

	Usage: required

	Value type: <stringlist>

	Definition: must be "q6dsp" and "rmb"



- interrupts-extended:

	Usage: required

	Value type: <prop-encoded-array>

	Definition: must list the watchdog, fatal IRQs ready, handover and

		    stop-ack IRQs



- interrupt-names:

	Usage: required

	Value type: <stringlist>

	Definition: must be "wdog", "fatal", "ready", "handover", "stop-ack"



- clocks:

	Usage: required

	Value type: <phandle>

	Definition: reference to the iface, bus and mem clocks to be held on

		    behalf of the booting of the Hexagon core



- clock-names:

	Usage: required

	Value type: <stringlist>

	Definition: must be "iface", "bus", "mem"



- resets:

	Usage: required

	Value type: <phandle>

	Definition: reference to the reset-controller for the modem sub-system



- reset-names:

	Usage: required

	Value type: <stringlist>

	Definition: must be "mss_restart"



- cx-supply:

- mss-supply:

- mx-supply:

- pll-supply:

	Usage: required

	Value type: <phandle>

	Definition: reference to the regulators to be held on behalf of the

		    booting of the Hexagon core



- qcom,smem-states:

	Usage: required

	Value type: <phandle>

	Definition: reference to the smem state for requesting the Hexagon to

		    shut down



- qcom,smem-state-names:

	Usage: required

	Value type: <stringlist>

	Definition: must be "stop"



- qcom,halt-regs:

	Usage: required

	Value type: <prop-encoded-array>

	Definition: a phandle reference to a syscon representing TCSR followed

		    by the three offsets within syscon for q6, modem and nc

		    halt registers.



= SUBNODES:

The Hexagon node must contain two subnodes, named "mba" and "mpss" representing

the memory regions used by the Hexagon firmware. Each sub-node must contain:



- memory-region:

	Usage: required

	Value type: <phandle>

	Definition: reference to the reserved-memory for the region



= EXAMPLE

The following example describes the resources needed to boot control the

Hexagon, as it is found on MSM8974 boards.



	modem-rproc@fc880000 {

		compatible = "qcom,q6v5-pil";

		reg = <0xfc880000 0x100>,

		      <0xfc820000 0x020>;

		reg-names = "qdsp6", "rmb";



		interrupts-extended = <&intc 0 24 1>,

				      <&modem_smp2p_in 0 0>,

				      <&modem_smp2p_in 1 0>,

				      <&modem_smp2p_in 2 0>,

				      <&modem_smp2p_in 3 0>;

		interrupt-names = "wdog",

				  "fatal",

				  "ready",

				  "handover",

				  "stop-ack";



		clocks = <&gcc GCC_MSS_Q6_BIMC_AXI_CLK>,

			 <&gcc GCC_MSS_CFG_AHB_CLK>,

			 <&gcc GCC_BOOT_ROM_AHB_CLK>;

		clock-names = "iface", "bus", "mem";



		qcom,halt-regs = <&tcsr_mutex_block 0x1180 0x1200 0x1280>;



		resets = <&gcc GCC_MSS_RESTART>;

		reset-names = "mss_restart";



		cx-supply = <&pm8841_s2>;

		mss-supply = <&pm8841_s3>;

		mx-supply = <&pm8841_s1>;

		pll-supply = <&pm8941_l12>;



		qcom,smem-states = <&modem_smp2p_out 0>;

		qcom,smem-state-names = "stop";



		mba {

			memory-region = <&mba_region>;

		};



		mpss {

			memory-region = <&mpss_region>;

		};

	};

MAINTAINERS

+2 −1
Original line number Diff line number Diff line
@@ -9732,8 +9732,9 @@ M: Bjorn Andersson <bjorn.andersson@linaro.org> 
L:	linux-remoteproc@vger.kernel.org

T:	git git://git.kernel.org/pub/scm/linux/kernel/git/ohad/remoteproc.git

S:	Maintained

F:	drivers/remoteproc/

F:	Documentation/devicetree/bindings/remoteproc/

F:	Documentation/remoteproc.txt

F:	drivers/remoteproc/

F:	include/linux/remoteproc.h



REMOTE PROCESSOR MESSAGING (RPMSG) SUBSYSTEM

drivers/remoteproc/Kconfig

+14 −0
Original line number Diff line number Diff line
@@ -77,6 +77,20 @@ config DA8XX_REMOTEPROC 
	  It's safe to say n here if you're not interested in multimedia

	  offloading.



config QCOM_MDT_LOADER

	tristate



config QCOM_Q6V5_PIL

	tristate "Qualcomm Hexagon V5 Peripherial Image Loader"

	depends on OF && ARCH_QCOM

	depends on QCOM_SMEM

	select MFD_SYSCON

	select QCOM_MDT_LOADER

	select REMOTEPROC

	help

	  Say y here to support the Qualcomm Peripherial Image Loader for the

	  Hexagon V5 based remote processors.



config ST_REMOTEPROC

	tristate "ST remoteproc support"

	depends on ARCH_STI

drivers/remoteproc/Makefile

+2 −0
Original line number Diff line number Diff line
@@ -11,4 +11,6 @@ obj-$(CONFIG_OMAP_REMOTEPROC) += omap_remoteproc.o 
obj-$(CONFIG_STE_MODEM_RPROC)	 	+= ste_modem_rproc.o

obj-$(CONFIG_WKUP_M3_RPROC)		+= wkup_m3_rproc.o

obj-$(CONFIG_DA8XX_REMOTEPROC)		+= da8xx_remoteproc.o

obj-$(CONFIG_QCOM_MDT_LOADER)		+= qcom_mdt_loader.o

obj-$(CONFIG_QCOM_Q6V5_PIL)		+= qcom_q6v5_pil.o

obj-$(CONFIG_ST_REMOTEPROC)		+= st_remoteproc.o

drivers/remoteproc/qcom_mdt_loader.c

0 → 100644
+179 −0
Original line number Diff line number Diff line 
/*

 * Qualcomm Peripheral Image Loader

 *

 * Copyright (C) 2016 Linaro Ltd

 * Copyright (C) 2015 Sony Mobile Communications Inc

 * Copyright (c) 2012-2013, 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 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.

 */



#include <linux/elf.h>

#include <linux/firmware.h>

#include <linux/kernel.h>

#include <linux/module.h>

#include <linux/remoteproc.h>

#include <linux/slab.h>



#include "remoteproc_internal.h"

#include "qcom_mdt_loader.h"



/**

 * qcom_mdt_find_rsc_table() - provide dummy resource table for remoteproc

 * @rproc:	remoteproc handle

 * @fw:		firmware header

 * @tablesz:	outgoing size of the table

 *

 * Returns a dummy table.

 */

struct resource_table *qcom_mdt_find_rsc_table(struct rproc *rproc,

					       const struct firmware *fw,

					       int *tablesz)

{

	static struct resource_table table = { .ver = 1, };



	*tablesz = sizeof(table);

	return &table;

}

EXPORT_SYMBOL_GPL(qcom_mdt_find_rsc_table);



/**

 * qcom_mdt_parse() - extract useful parameters from the mdt header

 * @fw:		firmware handle

 * @fw_addr:	optional reference for base of the firmware's memory region

 * @fw_size:	optional reference for size of the firmware's memory region

 * @fw_relocate: optional reference for flagging if the firmware is relocatable

 *

 * Returns 0 on success, negative errno otherwise.

 */

int qcom_mdt_parse(const struct firmware *fw, phys_addr_t *fw_addr,

		   size_t *fw_size, bool *fw_relocate)

{

	const struct elf32_phdr *phdrs;

	const struct elf32_phdr *phdr;

	const struct elf32_hdr *ehdr;

	phys_addr_t min_addr = (phys_addr_t)ULLONG_MAX;

	phys_addr_t max_addr = 0;

	bool relocate = false;

	int i;



	ehdr = (struct elf32_hdr *)fw->data;

	phdrs = (struct elf32_phdr *)(ehdr + 1);



	for (i = 0; i < ehdr->e_phnum; i++) {

		phdr = &phdrs[i];



		if (phdr->p_type != PT_LOAD)

			continue;



		if ((phdr->p_flags & QCOM_MDT_TYPE_MASK) == QCOM_MDT_TYPE_HASH)

			continue;



		if (!phdr->p_memsz)

			continue;



		if (phdr->p_flags & QCOM_MDT_RELOCATABLE)

			relocate = true;



		if (phdr->p_paddr < min_addr)

			min_addr = phdr->p_paddr;



		if (phdr->p_paddr + phdr->p_memsz > max_addr)

			max_addr = ALIGN(phdr->p_paddr + phdr->p_memsz, SZ_4K);

	}



	if (fw_addr)

		*fw_addr = min_addr;

	if (fw_size)

		*fw_size = max_addr - min_addr;

	if (fw_relocate)

		*fw_relocate = relocate;



	return 0;

}

EXPORT_SYMBOL_GPL(qcom_mdt_parse);



/**

 * qcom_mdt_load() - load the firmware which header is defined in fw

 * @rproc:	rproc handle

 * @fw:		frimware object for the header

 * @firmware:	filename of the firmware, for building .bXX names

 *

 * Returns 0 on success, negative errno otherwise.

 */

int qcom_mdt_load(struct rproc *rproc,

		  const struct firmware *fw,

		  const char *firmware)

{

	const struct elf32_phdr *phdrs;

	const struct elf32_phdr *phdr;

	const struct elf32_hdr *ehdr;

	size_t fw_name_len;

	char *fw_name;

	void *ptr;

	int ret;

	int i;



	ehdr = (struct elf32_hdr *)fw->data;

	phdrs = (struct elf32_phdr *)(ehdr + 1);



	fw_name_len = strlen(firmware);

	if (fw_name_len <= 4)

		return -EINVAL;



	fw_name = kstrdup(firmware, GFP_KERNEL);

	if (!fw_name)

		return -ENOMEM;



	for (i = 0; i < ehdr->e_phnum; i++) {

		phdr = &phdrs[i];



		if (phdr->p_type != PT_LOAD)

			continue;



		if ((phdr->p_flags & QCOM_MDT_TYPE_MASK) == QCOM_MDT_TYPE_HASH)

			continue;



		if (!phdr->p_memsz)

			continue;



		ptr = rproc_da_to_va(rproc, phdr->p_paddr, phdr->p_memsz);

		if (!ptr) {

			dev_err(&rproc->dev, "segment outside memory range\n");

			ret = -EINVAL;

			break;

		}



		if (phdr->p_filesz) {

			sprintf(fw_name + fw_name_len - 3, "b%02d", i);

			ret = request_firmware(&fw, fw_name, &rproc->dev);

			if (ret) {

				dev_err(&rproc->dev, "failed to load %s\n",

					fw_name);

				break;

			}



			memcpy(ptr, fw->data, fw->size);



			release_firmware(fw);

		}



		if (phdr->p_memsz > phdr->p_filesz)

			memset(ptr + phdr->p_filesz, 0, phdr->p_memsz - phdr->p_filesz);

	}



	kfree(fw_name);



	return ret;

}

EXPORT_SYMBOL_GPL(qcom_mdt_load);



MODULE_DESCRIPTION("Firmware parser for Qualcomm MDT format");

MODULE_LICENSE("GPL v2");