2 * drivers/w1/masters/omap_hdq.c
4 * Copyright (C) 2007,2012 Texas Instruments, Inc.
6 * This file is licensed under the terms of the GNU General Public License
7 * version 2. This program is licensed "as is" without any warranty of any
8 * kind, whether express or implied.
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/interrupt.h>
15 #include <linux/slab.h>
16 #include <linux/err.h>
18 #include <linux/sched.h>
19 #include <linux/pm_runtime.h>
22 #include "../w1_int.h"
24 #define MOD_NAME "OMAP_HDQ:"
26 #define OMAP_HDQ_REVISION 0x00
27 #define OMAP_HDQ_TX_DATA 0x04
28 #define OMAP_HDQ_RX_DATA 0x08
29 #define OMAP_HDQ_CTRL_STATUS 0x0c
30 #define OMAP_HDQ_CTRL_STATUS_INTERRUPTMASK (1<<6)
31 #define OMAP_HDQ_CTRL_STATUS_CLOCKENABLE (1<<5)
32 #define OMAP_HDQ_CTRL_STATUS_GO (1<<4)
33 #define OMAP_HDQ_CTRL_STATUS_INITIALIZATION (1<<2)
34 #define OMAP_HDQ_CTRL_STATUS_DIR (1<<1)
35 #define OMAP_HDQ_CTRL_STATUS_MODE (1<<0)
36 #define OMAP_HDQ_INT_STATUS 0x10
37 #define OMAP_HDQ_INT_STATUS_TXCOMPLETE (1<<2)
38 #define OMAP_HDQ_INT_STATUS_RXCOMPLETE (1<<1)
39 #define OMAP_HDQ_INT_STATUS_TIMEOUT (1<<0)
40 #define OMAP_HDQ_SYSCONFIG 0x14
41 #define OMAP_HDQ_SYSCONFIG_SOFTRESET (1<<1)
42 #define OMAP_HDQ_SYSCONFIG_AUTOIDLE (1<<0)
43 #define OMAP_HDQ_SYSSTATUS 0x18
44 #define OMAP_HDQ_SYSSTATUS_RESETDONE (1<<0)
46 #define OMAP_HDQ_FLAG_CLEAR 0
47 #define OMAP_HDQ_FLAG_SET 1
48 #define OMAP_HDQ_TIMEOUT (HZ/5)
50 #define OMAP_HDQ_MAX_USER 4
52 static DECLARE_WAIT_QUEUE_HEAD(hdq_wait_queue);
57 void __iomem *hdq_base;
58 /* lock status update */
59 struct mutex hdq_mutex;
63 spinlock_t hdq_spinlock;
65 * Used to control the call to omap_hdq_get and omap_hdq_put.
66 * HDQ Protocol: Write the CMD|REG_address first, followed by
67 * the data wrire or read.
72 static int omap_hdq_probe(struct platform_device *pdev);
73 static int omap_hdq_remove(struct platform_device *pdev);
75 static struct platform_driver omap_hdq_driver = {
76 .probe = omap_hdq_probe,
77 .remove = omap_hdq_remove,
83 static u8 omap_w1_read_byte(void *_hdq);
84 static void omap_w1_write_byte(void *_hdq, u8 byte);
85 static u8 omap_w1_reset_bus(void *_hdq);
86 static void omap_w1_search_bus(void *_hdq, struct w1_master *master_dev,
87 u8 search_type, w1_slave_found_callback slave_found);
90 static struct w1_bus_master omap_w1_master = {
91 .read_byte = omap_w1_read_byte,
92 .write_byte = omap_w1_write_byte,
93 .reset_bus = omap_w1_reset_bus,
94 .search = omap_w1_search_bus,
97 /* HDQ register I/O routines */
98 static inline u8 hdq_reg_in(struct hdq_data *hdq_data, u32 offset)
100 return __raw_readl(hdq_data->hdq_base + offset);
103 static inline void hdq_reg_out(struct hdq_data *hdq_data, u32 offset, u8 val)
105 __raw_writel(val, hdq_data->hdq_base + offset);
108 static inline u8 hdq_reg_merge(struct hdq_data *hdq_data, u32 offset,
111 u8 new_val = (__raw_readl(hdq_data->hdq_base + offset) & ~mask)
113 __raw_writel(new_val, hdq_data->hdq_base + offset);
119 * Wait for one or more bits in flag change.
120 * HDQ_FLAG_SET: wait until any bit in the flag is set.
121 * HDQ_FLAG_CLEAR: wait until all bits in the flag are cleared.
122 * return 0 on success and -ETIMEDOUT in the case of timeout.
124 static int hdq_wait_for_flag(struct hdq_data *hdq_data, u32 offset,
125 u8 flag, u8 flag_set, u8 *status)
128 unsigned long timeout = jiffies + OMAP_HDQ_TIMEOUT;
130 if (flag_set == OMAP_HDQ_FLAG_CLEAR) {
131 /* wait for the flag clear */
132 while (((*status = hdq_reg_in(hdq_data, offset)) & flag)
133 && time_before(jiffies, timeout)) {
134 schedule_timeout_uninterruptible(1);
138 } else if (flag_set == OMAP_HDQ_FLAG_SET) {
139 /* wait for the flag set */
140 while (!((*status = hdq_reg_in(hdq_data, offset)) & flag)
141 && time_before(jiffies, timeout)) {
142 schedule_timeout_uninterruptible(1);
144 if (!(*status & flag))
152 /* write out a byte and fill *status with HDQ_INT_STATUS */
153 static int hdq_write_byte(struct hdq_data *hdq_data, u8 val, u8 *status)
157 unsigned long irqflags;
161 spin_lock_irqsave(&hdq_data->hdq_spinlock, irqflags);
162 /* clear interrupt flags via a dummy read */
163 hdq_reg_in(hdq_data, OMAP_HDQ_INT_STATUS);
164 /* ISR loads it with new INT_STATUS */
165 hdq_data->hdq_irqstatus = 0;
166 spin_unlock_irqrestore(&hdq_data->hdq_spinlock, irqflags);
168 hdq_reg_out(hdq_data, OMAP_HDQ_TX_DATA, val);
171 hdq_reg_merge(hdq_data, OMAP_HDQ_CTRL_STATUS, OMAP_HDQ_CTRL_STATUS_GO,
172 OMAP_HDQ_CTRL_STATUS_DIR | OMAP_HDQ_CTRL_STATUS_GO);
173 /* wait for the TXCOMPLETE bit */
174 ret = wait_event_timeout(hdq_wait_queue,
175 hdq_data->hdq_irqstatus, OMAP_HDQ_TIMEOUT);
177 dev_dbg(hdq_data->dev, "TX wait elapsed\n");
182 *status = hdq_data->hdq_irqstatus;
183 /* check irqstatus */
184 if (!(*status & OMAP_HDQ_INT_STATUS_TXCOMPLETE)) {
185 dev_dbg(hdq_data->dev, "timeout waiting for"
186 " TXCOMPLETE/RXCOMPLETE, %x", *status);
191 /* wait for the GO bit return to zero */
192 ret = hdq_wait_for_flag(hdq_data, OMAP_HDQ_CTRL_STATUS,
193 OMAP_HDQ_CTRL_STATUS_GO,
194 OMAP_HDQ_FLAG_CLEAR, &tmp_status);
196 dev_dbg(hdq_data->dev, "timeout waiting GO bit"
197 " return to zero, %x", tmp_status);
204 /* HDQ Interrupt service routine */
205 static irqreturn_t hdq_isr(int irq, void *_hdq)
207 struct hdq_data *hdq_data = _hdq;
208 unsigned long irqflags;
210 spin_lock_irqsave(&hdq_data->hdq_spinlock, irqflags);
211 hdq_data->hdq_irqstatus = hdq_reg_in(hdq_data, OMAP_HDQ_INT_STATUS);
212 spin_unlock_irqrestore(&hdq_data->hdq_spinlock, irqflags);
213 dev_dbg(hdq_data->dev, "hdq_isr: %x", hdq_data->hdq_irqstatus);
215 if (hdq_data->hdq_irqstatus &
216 (OMAP_HDQ_INT_STATUS_TXCOMPLETE | OMAP_HDQ_INT_STATUS_RXCOMPLETE
217 | OMAP_HDQ_INT_STATUS_TIMEOUT)) {
218 /* wake up sleeping process */
219 wake_up(&hdq_wait_queue);
225 /* HDQ Mode: always return success */
226 static u8 omap_w1_reset_bus(void *_hdq)
231 /* W1 search callback function */
232 static void omap_w1_search_bus(void *_hdq, struct w1_master *master_dev,
233 u8 search_type, w1_slave_found_callback slave_found)
235 u64 module_id, rn_le, cs, id;
242 rn_le = cpu_to_le64(module_id);
244 * HDQ might not obey truly the 1-wire spec.
245 * So calculate CRC based on module parameter.
247 cs = w1_calc_crc8((u8 *)&rn_le, 7);
248 id = (cs << 56) | module_id;
250 slave_found(master_dev, id);
253 static int _omap_hdq_reset(struct hdq_data *hdq_data)
258 hdq_reg_out(hdq_data, OMAP_HDQ_SYSCONFIG, OMAP_HDQ_SYSCONFIG_SOFTRESET);
260 * Select HDQ mode & enable clocks.
261 * It is observed that INT flags can't be cleared via a read and GO/INIT
262 * won't return to zero if interrupt is disabled. So we always enable
265 hdq_reg_out(hdq_data, OMAP_HDQ_CTRL_STATUS,
266 OMAP_HDQ_CTRL_STATUS_CLOCKENABLE |
267 OMAP_HDQ_CTRL_STATUS_INTERRUPTMASK);
269 /* wait for reset to complete */
270 ret = hdq_wait_for_flag(hdq_data, OMAP_HDQ_SYSSTATUS,
271 OMAP_HDQ_SYSSTATUS_RESETDONE, OMAP_HDQ_FLAG_SET, &tmp_status);
273 dev_dbg(hdq_data->dev, "timeout waiting HDQ reset, %x",
276 hdq_reg_out(hdq_data, OMAP_HDQ_CTRL_STATUS,
277 OMAP_HDQ_CTRL_STATUS_CLOCKENABLE |
278 OMAP_HDQ_CTRL_STATUS_INTERRUPTMASK);
279 hdq_reg_out(hdq_data, OMAP_HDQ_SYSCONFIG,
280 OMAP_HDQ_SYSCONFIG_AUTOIDLE);
286 /* Issue break pulse to the device */
287 static int omap_hdq_break(struct hdq_data *hdq_data)
291 unsigned long irqflags;
293 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
295 dev_dbg(hdq_data->dev, "Could not acquire mutex\n");
300 spin_lock_irqsave(&hdq_data->hdq_spinlock, irqflags);
301 /* clear interrupt flags via a dummy read */
302 hdq_reg_in(hdq_data, OMAP_HDQ_INT_STATUS);
303 /* ISR loads it with new INT_STATUS */
304 hdq_data->hdq_irqstatus = 0;
305 spin_unlock_irqrestore(&hdq_data->hdq_spinlock, irqflags);
307 /* set the INIT and GO bit */
308 hdq_reg_merge(hdq_data, OMAP_HDQ_CTRL_STATUS,
309 OMAP_HDQ_CTRL_STATUS_INITIALIZATION | OMAP_HDQ_CTRL_STATUS_GO,
310 OMAP_HDQ_CTRL_STATUS_DIR | OMAP_HDQ_CTRL_STATUS_INITIALIZATION |
311 OMAP_HDQ_CTRL_STATUS_GO);
313 /* wait for the TIMEOUT bit */
314 ret = wait_event_timeout(hdq_wait_queue,
315 hdq_data->hdq_irqstatus, OMAP_HDQ_TIMEOUT);
317 dev_dbg(hdq_data->dev, "break wait elapsed\n");
322 tmp_status = hdq_data->hdq_irqstatus;
323 /* check irqstatus */
324 if (!(tmp_status & OMAP_HDQ_INT_STATUS_TIMEOUT)) {
325 dev_dbg(hdq_data->dev, "timeout waiting for TIMEOUT, %x",
331 * wait for both INIT and GO bits rerurn to zero.
332 * zero wait time expected for interrupt mode.
334 ret = hdq_wait_for_flag(hdq_data, OMAP_HDQ_CTRL_STATUS,
335 OMAP_HDQ_CTRL_STATUS_INITIALIZATION |
336 OMAP_HDQ_CTRL_STATUS_GO, OMAP_HDQ_FLAG_CLEAR,
339 dev_dbg(hdq_data->dev, "timeout waiting INIT&GO bits"
340 " return to zero, %x", tmp_status);
343 mutex_unlock(&hdq_data->hdq_mutex);
348 static int hdq_read_byte(struct hdq_data *hdq_data, u8 *val)
353 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
359 if (!hdq_data->hdq_usecount) {
364 if (!(hdq_data->hdq_irqstatus & OMAP_HDQ_INT_STATUS_RXCOMPLETE)) {
365 hdq_reg_merge(hdq_data, OMAP_HDQ_CTRL_STATUS,
366 OMAP_HDQ_CTRL_STATUS_DIR | OMAP_HDQ_CTRL_STATUS_GO,
367 OMAP_HDQ_CTRL_STATUS_DIR | OMAP_HDQ_CTRL_STATUS_GO);
369 * The RX comes immediately after TX.
371 wait_event_timeout(hdq_wait_queue,
372 (hdq_data->hdq_irqstatus
373 & OMAP_HDQ_INT_STATUS_RXCOMPLETE),
376 hdq_reg_merge(hdq_data, OMAP_HDQ_CTRL_STATUS, 0,
377 OMAP_HDQ_CTRL_STATUS_DIR);
378 status = hdq_data->hdq_irqstatus;
379 /* check irqstatus */
380 if (!(status & OMAP_HDQ_INT_STATUS_RXCOMPLETE)) {
381 dev_dbg(hdq_data->dev, "timeout waiting for"
382 " RXCOMPLETE, %x", status);
387 /* the data is ready. Read it in! */
388 *val = hdq_reg_in(hdq_data, OMAP_HDQ_RX_DATA);
390 mutex_unlock(&hdq_data->hdq_mutex);
396 /* Enable clocks and set the controller to HDQ mode */
397 static int omap_hdq_get(struct hdq_data *hdq_data)
401 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
407 if (OMAP_HDQ_MAX_USER == hdq_data->hdq_usecount) {
408 dev_dbg(hdq_data->dev, "attempt to exceed the max use count");
412 hdq_data->hdq_usecount++;
413 try_module_get(THIS_MODULE);
414 if (1 == hdq_data->hdq_usecount) {
416 pm_runtime_get_sync(hdq_data->dev);
418 /* make sure HDQ is out of reset */
419 if (!(hdq_reg_in(hdq_data, OMAP_HDQ_SYSSTATUS) &
420 OMAP_HDQ_SYSSTATUS_RESETDONE)) {
421 ret = _omap_hdq_reset(hdq_data);
423 /* back up the count */
424 hdq_data->hdq_usecount--;
426 /* select HDQ mode & enable clocks */
427 hdq_reg_out(hdq_data, OMAP_HDQ_CTRL_STATUS,
428 OMAP_HDQ_CTRL_STATUS_CLOCKENABLE |
429 OMAP_HDQ_CTRL_STATUS_INTERRUPTMASK);
430 hdq_reg_out(hdq_data, OMAP_HDQ_SYSCONFIG,
431 OMAP_HDQ_SYSCONFIG_AUTOIDLE);
432 hdq_reg_in(hdq_data, OMAP_HDQ_INT_STATUS);
438 mutex_unlock(&hdq_data->hdq_mutex);
443 /* Disable clocks to the module */
444 static int omap_hdq_put(struct hdq_data *hdq_data)
448 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
452 if (0 == hdq_data->hdq_usecount) {
453 dev_dbg(hdq_data->dev, "attempt to decrement use count"
457 hdq_data->hdq_usecount--;
458 module_put(THIS_MODULE);
459 if (0 == hdq_data->hdq_usecount)
460 pm_runtime_put_sync(hdq_data->dev);
462 mutex_unlock(&hdq_data->hdq_mutex);
467 /* Read a byte of data from the device */
468 static u8 omap_w1_read_byte(void *_hdq)
470 struct hdq_data *hdq_data = _hdq;
474 ret = hdq_read_byte(hdq_data, &val);
476 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
478 dev_dbg(hdq_data->dev, "Could not acquire mutex\n");
481 hdq_data->init_trans = 0;
482 mutex_unlock(&hdq_data->hdq_mutex);
483 omap_hdq_put(hdq_data);
487 /* Write followed by a read, release the module */
488 if (hdq_data->init_trans) {
489 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
491 dev_dbg(hdq_data->dev, "Could not acquire mutex\n");
494 hdq_data->init_trans = 0;
495 mutex_unlock(&hdq_data->hdq_mutex);
496 omap_hdq_put(hdq_data);
502 /* Write a byte of data to the device */
503 static void omap_w1_write_byte(void *_hdq, u8 byte)
505 struct hdq_data *hdq_data = _hdq;
509 /* First write to initialize the transfer */
510 if (hdq_data->init_trans == 0)
511 omap_hdq_get(hdq_data);
513 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
515 dev_dbg(hdq_data->dev, "Could not acquire mutex\n");
518 hdq_data->init_trans++;
519 mutex_unlock(&hdq_data->hdq_mutex);
521 ret = hdq_write_byte(hdq_data, byte, &status);
523 dev_dbg(hdq_data->dev, "TX failure:Ctrl status %x\n", status);
527 /* Second write, data transferred. Release the module */
528 if (hdq_data->init_trans > 1) {
529 omap_hdq_put(hdq_data);
530 ret = mutex_lock_interruptible(&hdq_data->hdq_mutex);
532 dev_dbg(hdq_data->dev, "Could not acquire mutex\n");
535 hdq_data->init_trans = 0;
536 mutex_unlock(&hdq_data->hdq_mutex);
540 static int omap_hdq_probe(struct platform_device *pdev)
542 struct device *dev = &pdev->dev;
543 struct hdq_data *hdq_data;
544 struct resource *res;
548 hdq_data = devm_kzalloc(dev, sizeof(*hdq_data), GFP_KERNEL);
550 dev_dbg(&pdev->dev, "unable to allocate memory\n");
555 platform_set_drvdata(pdev, hdq_data);
557 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
558 hdq_data->hdq_base = devm_ioremap_resource(dev, res);
559 if (IS_ERR(hdq_data->hdq_base))
560 return PTR_ERR(hdq_data->hdq_base);
562 hdq_data->hdq_usecount = 0;
563 mutex_init(&hdq_data->hdq_mutex);
565 pm_runtime_enable(&pdev->dev);
566 pm_runtime_get_sync(&pdev->dev);
568 rev = hdq_reg_in(hdq_data, OMAP_HDQ_REVISION);
569 dev_info(&pdev->dev, "OMAP HDQ Hardware Rev %c.%c. Driver in %s mode\n",
570 (rev >> 4) + '0', (rev & 0x0f) + '0', "Interrupt");
572 spin_lock_init(&hdq_data->hdq_spinlock);
574 irq = platform_get_irq(pdev, 0);
580 ret = devm_request_irq(dev, irq, hdq_isr, 0, "omap_hdq", hdq_data);
582 dev_dbg(&pdev->dev, "could not request irq\n");
586 omap_hdq_break(hdq_data);
588 pm_runtime_put_sync(&pdev->dev);
590 omap_w1_master.data = hdq_data;
592 ret = w1_add_master_device(&omap_w1_master);
594 dev_dbg(&pdev->dev, "Failure in registering w1 master\n");
601 pm_runtime_put_sync(&pdev->dev);
603 pm_runtime_disable(&pdev->dev);
608 static int omap_hdq_remove(struct platform_device *pdev)
610 struct hdq_data *hdq_data = platform_get_drvdata(pdev);
612 mutex_lock(&hdq_data->hdq_mutex);
614 if (hdq_data->hdq_usecount) {
615 dev_dbg(&pdev->dev, "removed when use count is not zero\n");
616 mutex_unlock(&hdq_data->hdq_mutex);
620 mutex_unlock(&hdq_data->hdq_mutex);
622 /* remove module dependency */
623 pm_runtime_disable(&pdev->dev);
628 module_platform_driver(omap_hdq_driver);
630 module_param(w1_id, int, S_IRUSR);
631 MODULE_PARM_DESC(w1_id, "1-wire id for the slave detection");
633 MODULE_AUTHOR("Texas Instruments");
634 MODULE_DESCRIPTION("HDQ driver Library");
635 MODULE_LICENSE("GPL");