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

Commit bf6dedf8 authored by Kyle Yan's avatar Kyle Yan Committed by Kyle Yan
Browse files

soc: qcom: gladiator_hang: Add snapshot of gladiator hang 



This is a snapshot of the gladiator hang driver as of msm-4.4 commit
<0c8cf71>.

Change-Id: Ic434a75a2892c5e2634d233dceccc58e570b3cc3
Signed-off-by: default avatarKyle Yan <kyan@codeaurora.org>
parent cdd5cbca

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

0 → 100644
+40 −0
Original line number Diff line number Diff line 
Gladiator Hang Detection provides sysfs entries for configuring

thresholds and enable on ACE_port, IO_port, M1_port, M2_port,

and PCIO_port



If gladiator is hung for threshold time (value * 5ns) and no

heart beat event from gladiator port to gladiator hang monitor

detection, gladiator hang interrupt would be generated to reset

the SOC to collect all cores context.



Gladiator hang detection can be enabled on different ports.



Writing 1 into ace_enabled sysfs entry, enables gladiator hang

detection on ACE port

Writing 1 into io_enabled sysfs entry, enables gladiator hang

detection on IO port

Writing 1 into ace_enabled sysfs entry, enables gladiator hang

detection on M1 port

Writing 1 into ace_enabled sysfs entry, enables gladiator hang

detection on M2 port

Writing 1 into pcio_enabled sysfs entry, enables gladiator hang

detection on PCIO port



Required properties:

- compatible : "qcom,gladiator-hang-detect"

- qcom, threshold-arr:

		Array of APCS_COMMON_GLADIATOR_HANG_THRESHOLD_n register

		address

- qcom, config-reg:

		APCS_COMMON_GLADIATOR_HANG_CONFIG register address



Optional properties:



Example:

	For msmcobalt:

		qcom,ghd {

				compatible = "qcom,gladiator-hang-detect";

				qcom,threshold-arr = <0x179d141c 0x179d1420

					0x179d1424 0x179d1428 0x179d1420 0x179d1430>;

				qcom,config-reg = <0x179d1434>;

		};

drivers/soc/qcom/Kconfig

+8 −0
Original line number Diff line number Diff line
@@ -80,3 +80,11 @@ config QCOM_WCNSS_CTRL 
	help

	  Client driver for the WCNSS_CTRL SMD channel, used to download nv

	  firmware to a newly booted WCNSS chip.



config MSM_GLADIATOR_HANG_DETECT

       tristate "MSM Gladiator Hang Detection Support"

       help

         This enables the gladiator hang detection module.

         If the configured threshold is reached, it causes SoC reset on

         gladiator hang detection and collects the context for the

         gladiator hang.

drivers/soc/qcom/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -10,3 +10,4 @@ obj-$(CONFIG_QCOM_WCNSS_CTRL) += wcnss_ctrl.o 
CFLAGS_scm.o :=$(call as-instr,.arch_extension sec,-DREQUIRES_SEC=1)

obj-$(CONFIG_QCOM_SCM)  +=      scm.o scm-boot.o

obj-$(CONFIG_SOC_BUS) += socinfo.o

obj-$(CONFIG_MSM_GLADIATOR_HANG_DETECT) += gladiator_hang_detect.o

drivers/soc/qcom/gladiator_hang_detect.c

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

 */



#include <linux/module.h>

#include <linux/kernel.h>

#include <linux/of.h>

#include <linux/cpu.h>

#include <linux/sysfs.h>

#include <linux/kobject.h>

#include <linux/stat.h>

#include <soc/qcom/scm.h>

#include <linux/platform_device.h>



#define ACE_OFFSET	0

#define IO_OFFSET	2

#define M1_OFFSET	3

#define M2_OFFSET	4

#define PCIO_OFFSET	5

#define ENABLE_MASK_BITS	0x1



#define _VAL(z)			(ENABLE_MASK_BITS << z##_OFFSET)

#define _VALUE(_val, z)		(_val<<(z##_OFFSET))

#define _WRITE(x, y, z)		(((~(_VAL(z))) & y) | _VALUE(x, z))



#define NR_GLA_REG 6

#define MODULE_NAME	"gladiator_hang_detect"

#define MAX_THRES	0xFFFFFFFF

#define MAX_LEN_SYSFS 12



struct hang_detect {

	phys_addr_t threshold[NR_GLA_REG];

	phys_addr_t config;

	int ACE_enable, IO_enable, M1_enable, M2_enable, PCIO_enable;

	uint32_t ACE_threshold, IO_threshold, M1_threshold, M2_threshold,

			 PCIO_threshold;

	struct kobject kobj;

	struct mutex lock;

};



/* interface for exporting attributes */

struct gladiator_hang_attr {

	struct attribute        attr;

	ssize_t (*show)(struct kobject *kobj, struct attribute *attr,

			char *buf);

	size_t (*store)(struct kobject *kobj, struct attribute *attr,

			const char *buf, size_t count);

};



#define GLADIATOR_HANG_ATTR(_name, _mode, _show, _store)	\

	struct gladiator_hang_attr hang_attr_##_name =	\

			__ATTR(_name, _mode, _show, _store)



#define to_gladiator_hang_dev(kobj) \

	container_of(kobj, struct hang_detect, kobj)



#define to_gladiator_attr(_attr) \

	container_of(_attr, struct gladiator_hang_attr, attr)



static void set_threshold(int offset, struct hang_detect *hang_dev,

		int32_t threshold_val)

{

	switch (offset) {

	case ACE_OFFSET:

		hang_dev->ACE_threshold = threshold_val;

		break;

	case IO_OFFSET:

		hang_dev->IO_threshold = threshold_val;

		break;

	case M1_OFFSET:

		hang_dev->M1_threshold = threshold_val;

		break;

	case M2_OFFSET:

		hang_dev->M2_threshold = threshold_val;

		break;

	case PCIO_OFFSET:

		hang_dev->PCIO_threshold = threshold_val;

		break;

	}

}



static void get_threshold(int offset, struct hang_detect *hang_dev,

		uint32_t *reg_value)

{

	switch (offset) {

	case ACE_OFFSET:

		*reg_value = hang_dev->ACE_threshold;

	break;

	case IO_OFFSET:

		*reg_value = hang_dev->IO_threshold;

		break;

	case M1_OFFSET:

		*reg_value = hang_dev->M1_threshold;

		break;

	case M2_OFFSET:

		*reg_value = hang_dev->M2_threshold;

		break;

	case PCIO_OFFSET:

		*reg_value = hang_dev->PCIO_threshold;

		break;

	}

}



static void set_enable(int offset, struct hang_detect *hang_dev,

		int enabled)

{

	switch (offset) {

	case ACE_OFFSET:

		hang_dev->ACE_enable = enabled;

		break;

	case IO_OFFSET:

		hang_dev->IO_enable = enabled;

		break;

	case M1_OFFSET:

		hang_dev->M1_enable = enabled;

		break;

	case M2_OFFSET:

		hang_dev->M2_enable = enabled;

		break;

	case PCIO_OFFSET:

		hang_dev->PCIO_enable = enabled;

		break;

	}

}



static void get_enable(int offset, struct hang_detect *hang_dev,

		uint32_t *reg_value)

{

	switch (offset) {

	case ACE_OFFSET:

		*reg_value = hang_dev->ACE_enable;

		break;

	case IO_OFFSET:

		*reg_value = hang_dev->IO_enable;

		break;

	case M1_OFFSET:

		*reg_value = hang_dev->M1_enable;

		break;

	case M2_OFFSET:

		*reg_value = hang_dev->M2_enable;

		break;

	case PCIO_OFFSET:

		*reg_value = hang_dev->PCIO_enable;

		break;

	}

}



static void scm_enable_write(int offset, struct hang_detect *hang_dev,

		int enabled, uint32_t reg_value, int *ret)

{

	switch (offset) {

	case ACE_OFFSET:

		*ret = scm_io_write(hang_dev->config,

			_WRITE(enabled, reg_value, ACE));

		break;

	case IO_OFFSET:

		*ret = scm_io_write(hang_dev->config,

				_WRITE(enabled, reg_value, IO));

		break;

	case M1_OFFSET:

		*ret = scm_io_write(hang_dev->config,

				_WRITE(enabled, reg_value, M1));

		break;

	case M2_OFFSET:

		*ret = scm_io_write(hang_dev->config,

				_WRITE(enabled, reg_value, M2));

		break;

	case PCIO_OFFSET:

		*ret = scm_io_write(hang_dev->config,

				_WRITE(enabled, reg_value, PCIO));

		break;

	}

}



static int enable_check(const char *buf, int *enabled_pt)

{

	int ret;



	ret = kstrtouint(buf, 0, enabled_pt);

	if (ret < 0)

		return ret;

	if (!(*enabled_pt == 0 || *enabled_pt == 1))

		return -EINVAL;

	return ret;

}





static inline ssize_t generic_enable_show(struct kobject *kobj,

		struct attribute *attr, char *buf, int offset)

{

	struct hang_detect *hang_dev = to_gladiator_hang_dev(kobj);

	uint32_t reg_value;



	get_enable(offset, hang_dev, &reg_value);

	return snprintf(buf, MAX_LEN_SYSFS, "%u\n", reg_value);

}



static inline ssize_t generic_threshold_show(struct kobject *kobj,

		struct attribute *attr, char *buf, int offset)

{

	struct hang_detect *hang_dev = to_gladiator_hang_dev(kobj);

	uint32_t reg_value;



	get_threshold(offset, hang_dev, &reg_value);

	return snprintf(buf, MAX_LEN_SYSFS, "0x%x\n", reg_value);

}



static inline size_t generic_threshold_store(struct kobject *kobj,

		struct attribute *attr, const char *buf, size_t count,

		int offset)

{

	struct hang_detect *hang_dev = to_gladiator_hang_dev(kobj);

	uint32_t threshold_val;

	int ret;



	ret = kstrtouint(buf, 0, &threshold_val);

	if (ret < 0)

		return ret;

	if (threshold_val <= 0 || threshold_val > MAX_THRES)

		return -EINVAL;

	if (scm_io_write(hang_dev->threshold[offset],

				threshold_val)){

		pr_err("%s: Failed to set threshold for gladiator port",

				__func__);

		return -EIO;

	}

	set_threshold(offset, hang_dev, threshold_val);

	return count;

}



static inline size_t generic_enable_store(struct kobject *kobj,

		struct attribute *attr, const char *buf, size_t count,

		int offset)

{

	int  ret, enabled;

	uint32_t reg_value;

	struct hang_detect *hang_dev = to_gladiator_hang_dev(kobj);



	ret = enable_check(buf, &enabled);

	if (ret < 0)

		return ret;

	get_threshold(offset, hang_dev, &reg_value);

	if (reg_value <= 0)

		return -EPERM;

	mutex_lock(&hang_dev->lock);

	reg_value = scm_io_read(hang_dev->config);



	scm_enable_write(offset, hang_dev, enabled, reg_value, &ret);



	if (ret) {

		pr_err("%s: Gladiator failed to set enable for port %s\n",

				__func__, "#_name");

		mutex_unlock(&hang_dev->lock);

		return -EIO;

	}

	mutex_unlock(&hang_dev->lock);

	set_enable(offset, hang_dev, enabled);

	return count;

}





static ssize_t attr_show(struct kobject *kobj, struct attribute *attr,

				char *buf)

{

	struct gladiator_hang_attr *gladiator_attr = to_gladiator_attr(attr);

	ssize_t ret = -EIO;



	if (gladiator_attr->show)

		ret = gladiator_attr->show(kobj, attr, buf);



	return ret;

}



static ssize_t attr_store(struct kobject *kobj, struct attribute *attr,

				const char *buf, size_t count)

{

	struct gladiator_hang_attr *gladiator_attr = to_gladiator_attr(attr);

	ssize_t ret = -EIO;



	if (gladiator_attr->store)

		ret = gladiator_attr->store(kobj, attr, buf, count);



	return ret;

}



static const struct sysfs_ops gladiator_sysfs_ops = {

	.show	= attr_show,

	.store	= attr_store,

};



static struct kobj_type gladiator_ktype = {

	.sysfs_ops	= &gladiator_sysfs_ops,

};



static ssize_t show_ace_threshold(struct kobject *kobj, struct attribute *attr,

				char *buf)

{

	return generic_threshold_show(kobj, attr, buf, ACE_OFFSET);

}



static size_t store_ace_threshold(struct kobject *kobj, struct attribute *attr,

				const char *buf, size_t count)

{

	return generic_threshold_store(kobj, attr, buf, count, ACE_OFFSET);

}

GLADIATOR_HANG_ATTR(ace_threshold, S_IRUGO|S_IWUSR, show_ace_threshold,

					store_ace_threshold);



static ssize_t show_io_threshold(struct kobject *kobj, struct attribute *attr,

				char *buf)

{

	return generic_threshold_show(kobj, attr, buf, IO_OFFSET);

}



static size_t store_io_threshold(struct kobject *kobj, struct attribute *attr,

				const char *buf, size_t count)

{

	return generic_threshold_store(kobj, attr, buf, count, IO_OFFSET);

}

GLADIATOR_HANG_ATTR(io_threshold, S_IRUGO|S_IWUSR, show_io_threshold,

					store_io_threshold);



static ssize_t show_m1_threshold(struct kobject *kobj, struct attribute *attr,

				char *buf)

{

	return generic_threshold_show(kobj, attr, buf, M1_OFFSET);

}



static size_t store_m1_threshold(struct kobject *kobj, struct attribute *attr,

				const char *buf, size_t count)

{

	return generic_threshold_store(kobj, attr, buf, count, M1_OFFSET);

}

GLADIATOR_HANG_ATTR(m1_threshold, S_IRUGO|S_IWUSR, show_m1_threshold,

					store_m1_threshold);



static ssize_t show_m2_threshold(struct kobject *kobj, struct attribute *attr,

				char *buf)

{

	return generic_threshold_show(kobj, attr, buf, M2_OFFSET);

}



static size_t store_m2_threshold(struct kobject *kobj, struct attribute *attr,

				const char *buf, size_t count)

{

	return generic_threshold_store(kobj, attr, buf, count, M2_OFFSET);

}

GLADIATOR_HANG_ATTR(m2_threshold, S_IRUGO|S_IWUSR, show_m2_threshold,

					store_m2_threshold);



static ssize_t show_pcio_threshold(struct kobject *kobj, struct attribute *attr,

				char *buf)

{

	return generic_threshold_show(kobj, attr, buf, PCIO_OFFSET);

}



static size_t store_pcio_threshold(struct kobject *kobj, struct attribute *attr,

				const char *buf, size_t count)

{

	return generic_threshold_store(kobj, attr, buf, count, PCIO_OFFSET);

}

GLADIATOR_HANG_ATTR(pcio_threshold, S_IRUGO|S_IWUSR, show_pcio_threshold,

					store_pcio_threshold);



static ssize_t show_ace_enable(struct kobject *kobj,

			struct attribute *attr, char *buf)

{

	return generic_enable_show(kobj, attr, buf, ACE_OFFSET);

}



static size_t store_ace_enable(struct kobject *kobj,

			struct attribute *attr, const char *buf, size_t count)

{

	return generic_enable_store(kobj, attr, buf, count, ACE_OFFSET);

}

GLADIATOR_HANG_ATTR(ace_enable, S_IRUGO|S_IWUSR, show_ace_enable,

		store_ace_enable);



static ssize_t show_io_enable(struct kobject *kobj,

			struct attribute *attr, char *buf)

{

	return generic_enable_show(kobj, attr, buf, IO_OFFSET);

}



static size_t store_io_enable(struct kobject *kobj,

			struct attribute *attr, const char *buf, size_t count)

{

	return generic_enable_store(kobj, attr, buf, count, IO_OFFSET);

}

GLADIATOR_HANG_ATTR(io_enable, S_IRUGO|S_IWUSR,

		show_io_enable, store_io_enable);





static ssize_t show_m1_enable(struct kobject *kobj,

			struct attribute *attr, char *buf)

{

	return generic_enable_show(kobj, attr, buf, M1_OFFSET);

}



static size_t store_m1_enable(struct kobject *kobj,

			struct attribute *attr, const char *buf, size_t count)

{

	return generic_enable_store(kobj, attr, buf, count, M1_OFFSET);

}

GLADIATOR_HANG_ATTR(m1_enable, S_IRUGO|S_IWUSR,

		show_m1_enable, store_m1_enable);



static ssize_t show_m2_enable(struct kobject *kobj,

			struct attribute *attr, char *buf)

{

	return generic_enable_show(kobj, attr, buf, M2_OFFSET);

}



static size_t store_m2_enable(struct kobject *kobj,

			struct attribute *attr, const char *buf, size_t count)

{

	return generic_enable_store(kobj, attr, buf, count, M2_OFFSET);

}

GLADIATOR_HANG_ATTR(m2_enable, S_IRUGO|S_IWUSR,

		show_m2_enable, store_m2_enable);



static ssize_t show_pcio_enable(struct kobject *kobj,

			struct attribute *attr, char *buf)

{

	return generic_enable_show(kobj, attr, buf, PCIO_OFFSET);

}



static size_t store_pcio_enable(struct kobject *kobj,

			struct attribute *attr, const char *buf, size_t count)

{

	return generic_enable_store(kobj, attr, buf, count, PCIO_OFFSET);

}

GLADIATOR_HANG_ATTR(pcio_enable, S_IRUGO|S_IWUSR,

		show_pcio_enable, store_pcio_enable);



static struct attribute *hang_attrs[] = {

	&hang_attr_ace_threshold.attr,

	&hang_attr_io_threshold.attr,

	&hang_attr_m1_threshold.attr,

	&hang_attr_m2_threshold.attr,

	&hang_attr_pcio_threshold.attr,

	&hang_attr_ace_enable.attr,

	&hang_attr_io_enable.attr,

	&hang_attr_m1_enable.attr,

	&hang_attr_m2_enable.attr,

	&hang_attr_pcio_enable.attr,

	NULL

};



static struct attribute_group hang_attr_group = {

	.attrs = hang_attrs,

};



static const struct of_device_id msm_gladiator_hang_detect_table[] = {

	{ .compatible = "qcom,gladiator-hang-detect" },

	{}

};



static int msm_gladiator_hang_detect_probe(struct platform_device *pdev)

{

	struct device_node *node = pdev->dev.of_node;

	struct hang_detect *hang_det = NULL;

	int i = 0, ret;

	u32 treg[NR_GLA_REG], creg;



	if (!pdev->dev.of_node)

		return -ENODEV;



	hang_det = devm_kzalloc(&pdev->dev,

			sizeof(struct hang_detect), GFP_KERNEL);



	if (!hang_det) {

		pr_err("Can't allocate hang_detect memory\n");

		return -ENOMEM;

	}



	ret = of_property_read_u32_array(node, "qcom,threshold-arr",

			treg, NR_GLA_REG);

	if (ret) {

		pr_err("Can't get threshold-arr property\n");

		return -EINVAL;

	}



	ret = of_property_read_u32(node, "qcom,config-reg", &creg);

	if (ret) {

		pr_err("Can't get config-reg property\n");

		return -EINVAL;

	}



	for (i = 0 ; i < NR_GLA_REG ; i++)

		hang_det->threshold[i] = treg[i];



	hang_det->config = creg;



	ret = kobject_init_and_add(&hang_det->kobj, &gladiator_ktype,

		&cpu_subsys.dev_root->kobj, "%s", "gladiator_hang_detect");

	if (ret) {

		pr_err("%s:Error in creation kobject_add\n", __func__);

		goto out_put_kobj;

	}



	ret = sysfs_create_group(&hang_det->kobj, &hang_attr_group);

	if (ret) {

		pr_err("%s:Error in creation sysfs_create_group\n", __func__);

		goto out_del_kobj;

	}

	mutex_init(&hang_det->lock);

	platform_set_drvdata(pdev, hang_det);

	return 0;



out_del_kobj:

	kobject_del(&hang_det->kobj);

out_put_kobj:

	kobject_put(&hang_det->kobj);



	return ret;

}



static int msm_gladiator_hang_detect_remove(struct platform_device *pdev)

{

	struct hang_detect *hang_det = platform_get_drvdata(pdev);



	platform_set_drvdata(pdev, NULL);

	sysfs_remove_group(&hang_det->kobj, &hang_attr_group);

	kobject_del(&hang_det->kobj);

	kobject_put(&hang_det->kobj);

	mutex_destroy(&hang_det->lock);

	return 0;

}



static struct platform_driver msm_gladiator_hang_detect_driver = {

	.probe = msm_gladiator_hang_detect_probe,

	.remove = msm_gladiator_hang_detect_remove,

	.driver = {

		.name = MODULE_NAME,

		.owner = THIS_MODULE,

		.of_match_table = msm_gladiator_hang_detect_table,

	},

};



static int __init init_gladiator_hang_detect(void)

{

	return platform_driver_register(&msm_gladiator_hang_detect_driver);

}

module_init(init_gladiator_hang_detect);



static void __exit exit_gladiator_hang_detect(void)

{

	platform_driver_unregister(&msm_gladiator_hang_detect_driver);

}

module_exit(exit_gladiator_hang_detect);



MODULE_DESCRIPTION("MSM Gladiator Hang Detect Driver");