omap_hwspinlock.c 5.39 KB
Newer Older
1 2 3
/*
 * OMAP hardware spinlock driver
 *
4
 * Copyright (C) 2010-2015 Texas Instruments Incorporated - http://www.ti.com
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * Contact: Simon Que <sque@ti.com>
 *          Hari Kanigeri <h-kanigeri2@ti.com>
 *          Ohad Ben-Cohen <ohad@wizery.com>
 *
 * 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/kernel.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/delay.h>
#include <linux/io.h>
#include <linux/bitops.h>
#include <linux/pm_runtime.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/hwspinlock.h>
30
#include <linux/of.h>
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#include <linux/platform_device.h>

#include "hwspinlock_internal.h"

/* Spinlock register offsets */
#define SYSSTATUS_OFFSET		0x0014
#define LOCK_BASE_OFFSET		0x0800

#define SPINLOCK_NUMLOCKS_BIT_OFFSET	(24)

/* Possible values of SPINLOCK_LOCK_REG */
#define SPINLOCK_NOTTAKEN		(0)	/* free */
#define SPINLOCK_TAKEN			(1)	/* locked */

static int omap_hwspinlock_trylock(struct hwspinlock *lock)
{
47
	void __iomem *lock_addr = lock->priv;
48 49

	/* attempt to acquire the lock by reading its value */
50
	return (SPINLOCK_NOTTAKEN == readl(lock_addr));
51 52 53 54
}

static void omap_hwspinlock_unlock(struct hwspinlock *lock)
{
55
	void __iomem *lock_addr = lock->priv;
56 57

	/* release the lock by writing 0 to it */
58
	writel(SPINLOCK_NOTTAKEN, lock_addr);
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
}

/*
 * relax the OMAP interconnect while spinning on it.
 *
 * The specs recommended that the retry delay time will be
 * just over half of the time that a requester would be
 * expected to hold the lock.
 *
 * The number below is taken from an hardware specs example,
 * obviously it is somewhat arbitrary.
 */
static void omap_hwspinlock_relax(struct hwspinlock *lock)
{
	ndelay(50);
}

static const struct hwspinlock_ops omap_hwspinlock_ops = {
	.trylock = omap_hwspinlock_trylock,
	.unlock = omap_hwspinlock_unlock,
	.relax = omap_hwspinlock_relax,
};

82
static int omap_hwspinlock_probe(struct platform_device *pdev)
83
{
84
	struct device_node *node = pdev->dev.of_node;
85 86
	struct hwspinlock_device *bank;
	struct hwspinlock *hwlock;
87 88
	struct resource *res;
	void __iomem *io_base;
89
	int num_locks, i, ret;
90 91
	/* Only a single hwspinlock block device is supported */
	int base_id = 0;
92

93
	if (!node)
94 95
		return -ENODEV;

96 97 98 99 100
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res)
		return -ENODEV;

	io_base = ioremap(res->start, resource_size(res));
101 102
	if (!io_base)
		return -ENOMEM;
103

104 105 106 107 108 109 110 111 112 113 114
	/*
	 * make sure the module is enabled and clocked before reading
	 * the module SYSSTATUS register
	 */
	pm_runtime_enable(&pdev->dev);
	ret = pm_runtime_get_sync(&pdev->dev);
	if (ret < 0) {
		pm_runtime_put_noidle(&pdev->dev);
		goto iounmap_base;
	}

115 116 117 118
	/* Determine number of locks */
	i = readl(io_base + SYSSTATUS_OFFSET);
	i >>= SPINLOCK_NUMLOCKS_BIT_OFFSET;

119 120 121 122 123 124 125 126
	/*
	 * runtime PM will make sure the clock of this module is
	 * enabled again iff at least one lock is requested
	 */
	ret = pm_runtime_put(&pdev->dev);
	if (ret < 0)
		goto iounmap_base;

127 128 129 130 131 132
	/* one of the four lsb's must be set, and nothing else */
	if (hweight_long(i & 0xf) != 1 || i > 8) {
		ret = -EINVAL;
		goto iounmap_base;
	}

133
	num_locks = i * 32; /* actual number of locks in this device */
134

135 136
	bank = kzalloc(sizeof(*bank) + num_locks * sizeof(*hwlock), GFP_KERNEL);
	if (!bank) {
137 138 139 140
		ret = -ENOMEM;
		goto iounmap_base;
	}

141
	platform_set_drvdata(pdev, bank);
142

143 144
	for (i = 0, hwlock = &bank->lock[0]; i < num_locks; i++, hwlock++)
		hwlock->priv = io_base + LOCK_BASE_OFFSET + sizeof(u32) * i;
145

146
	ret = hwspin_lock_register(bank, &pdev->dev, &omap_hwspinlock_ops,
147
						base_id, num_locks);
148 149
	if (ret)
		goto reg_fail;
150 151 152

	return 0;

153 154
reg_fail:
	kfree(bank);
155
iounmap_base:
156
	pm_runtime_disable(&pdev->dev);
157 158 159 160
	iounmap(io_base);
	return ret;
}

161
static int omap_hwspinlock_remove(struct platform_device *pdev)
162
{
163 164 165 166 167 168 169 170
	struct hwspinlock_device *bank = platform_get_drvdata(pdev);
	void __iomem *io_base = bank->lock[0].priv - LOCK_BASE_OFFSET;
	int ret;

	ret = hwspin_lock_unregister(bank);
	if (ret) {
		dev_err(&pdev->dev, "%s failed: %d\n", __func__, ret);
		return ret;
171 172 173
	}

	pm_runtime_disable(&pdev->dev);
174 175
	iounmap(io_base);
	kfree(bank);
176 177 178 179

	return 0;
}

180 181 182 183 184 185
static const struct of_device_id omap_hwspinlock_of_match[] = {
	{ .compatible = "ti,omap4-hwspinlock", },
	{ /* end */ },
};
MODULE_DEVICE_TABLE(of, omap_hwspinlock_of_match);

186 187
static struct platform_driver omap_hwspinlock_driver = {
	.probe		= omap_hwspinlock_probe,
188
	.remove		= omap_hwspinlock_remove,
189 190
	.driver		= {
		.name	= "omap_hwspinlock",
191
		.of_match_table = of_match_ptr(omap_hwspinlock_of_match),
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
	},
};

static int __init omap_hwspinlock_init(void)
{
	return platform_driver_register(&omap_hwspinlock_driver);
}
/* board init code might need to reserve hwspinlocks for predefined purposes */
postcore_initcall(omap_hwspinlock_init);

static void __exit omap_hwspinlock_exit(void)
{
	platform_driver_unregister(&omap_hwspinlock_driver);
}
module_exit(omap_hwspinlock_exit);

MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("Hardware spinlock driver for OMAP");
MODULE_AUTHOR("Simon Que <sque@ti.com>");
MODULE_AUTHOR("Hari Kanigeri <h-kanigeri2@ti.com>");
MODULE_AUTHOR("Ohad Ben-Cohen <ohad@wizery.com>");