Merge tag 'staging-3.9-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[linux-3.10.git] / drivers / staging / nvec / nvec.c
1 /*
2  * NVEC: NVIDIA compliant embedded controller interface
3  *
4  * Copyright (C) 2011 The AC100 Kernel Team <ac100@lists.lauchpad.net>
5  *
6  * Authors:  Pierre-Hugues Husson <phhusson@free.fr>
7  *           Ilya Petrov <ilya.muromec@gmail.com>
8  *           Marc Dietrich <marvin24@gmx.de>
9  *           Julian Andres Klode <jak@jak-linux.org>
10  *
11  * This file is subject to the terms and conditions of the GNU General Public
12  * License.  See the file "COPYING" in the main directory of this archive
13  * for more details.
14  *
15  */
16
17 /* #define DEBUG */
18
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/atomic.h>
22 #include <linux/clk.h>
23 #include <linux/completion.h>
24 #include <linux/delay.h>
25 #include <linux/err.h>
26 #include <linux/gpio.h>
27 #include <linux/interrupt.h>
28 #include <linux/io.h>
29 #include <linux/irq.h>
30 #include <linux/of.h>
31 #include <linux/of_gpio.h>
32 #include <linux/list.h>
33 #include <linux/mfd/core.h>
34 #include <linux/mutex.h>
35 #include <linux/notifier.h>
36 #include <linux/platform_device.h>
37 #include <linux/slab.h>
38 #include <linux/spinlock.h>
39 #include <linux/workqueue.h>
40
41 #include <mach/clk.h>
42
43 #include "nvec.h"
44
45 #define I2C_CNFG                        0x00
46 #define I2C_CNFG_PACKET_MODE_EN         (1<<10)
47 #define I2C_CNFG_NEW_MASTER_SFM         (1<<11)
48 #define I2C_CNFG_DEBOUNCE_CNT_SHIFT     12
49
50 #define I2C_SL_CNFG             0x20
51 #define I2C_SL_NEWSL            (1<<2)
52 #define I2C_SL_NACK             (1<<1)
53 #define I2C_SL_RESP             (1<<0)
54 #define I2C_SL_IRQ              (1<<3)
55 #define END_TRANS               (1<<4)
56 #define RCVD                    (1<<2)
57 #define RNW                     (1<<1)
58
59 #define I2C_SL_RCVD             0x24
60 #define I2C_SL_STATUS           0x28
61 #define I2C_SL_ADDR1            0x2c
62 #define I2C_SL_ADDR2            0x30
63 #define I2C_SL_DELAY_COUNT      0x3c
64
65 /**
66  * enum nvec_msg_category - Message categories for nvec_msg_alloc()
67  * @NVEC_MSG_RX: The message is an incoming message (from EC)
68  * @NVEC_MSG_TX: The message is an outgoing message (to EC)
69  */
70 enum nvec_msg_category  {
71         NVEC_MSG_RX,
72         NVEC_MSG_TX,
73 };
74
75 enum nvec_sleep_subcmds {
76         GLOBAL_EVENTS,
77         AP_PWR_DOWN,
78         AP_SUSPEND,
79 };
80
81 #define CNF_EVENT_REPORTING 0x01
82 #define GET_FIRMWARE_VERSION 0x15
83 #define LID_SWITCH BIT(1)
84 #define PWR_BUTTON BIT(15)
85
86 static struct nvec_chip *nvec_power_handle;
87
88 static struct mfd_cell nvec_devices[] = {
89         {
90                 .name = "nvec-kbd",
91                 .id = 1,
92         },
93         {
94                 .name = "nvec-mouse",
95                 .id = 1,
96         },
97         {
98                 .name = "nvec-power",
99                 .id = 1,
100         },
101         {
102                 .name = "nvec-power",
103                 .id = 2,
104         },
105         {
106                 .name = "nvec-paz00",
107                 .id = 1,
108         },
109 };
110
111 /**
112  * nvec_register_notifier - Register a notifier with nvec
113  * @nvec: A &struct nvec_chip
114  * @nb: The notifier block to register
115  *
116  * Registers a notifier with @nvec. The notifier will be added to an atomic
117  * notifier chain that is called for all received messages except those that
118  * correspond to a request initiated by nvec_write_sync().
119  */
120 int nvec_register_notifier(struct nvec_chip *nvec, struct notifier_block *nb,
121                            unsigned int events)
122 {
123         return atomic_notifier_chain_register(&nvec->notifier_list, nb);
124 }
125 EXPORT_SYMBOL_GPL(nvec_register_notifier);
126
127 /**
128  * nvec_status_notifier - The final notifier
129  *
130  * Prints a message about control events not handled in the notifier
131  * chain.
132  */
133 static int nvec_status_notifier(struct notifier_block *nb,
134                                 unsigned long event_type, void *data)
135 {
136         struct nvec_chip *nvec = container_of(nb, struct nvec_chip,
137                                                 nvec_status_notifier);
138         unsigned char *msg = (unsigned char *)data;
139
140         if (event_type != NVEC_CNTL)
141                 return NOTIFY_DONE;
142
143         dev_warn(nvec->dev, "unhandled msg type %ld\n", event_type);
144         print_hex_dump(KERN_WARNING, "payload: ", DUMP_PREFIX_NONE, 16, 1,
145                 msg, msg[1] + 2, true);
146
147         return NOTIFY_OK;
148 }
149
150 /**
151  * nvec_msg_alloc:
152  * @nvec: A &struct nvec_chip
153  * @category: Pool category, see &enum nvec_msg_category
154  *
155  * Allocate a single &struct nvec_msg object from the message pool of
156  * @nvec. The result shall be passed to nvec_msg_free() if no longer
157  * used.
158  *
159  * Outgoing messages are placed in the upper 75% of the pool, keeping the
160  * lower 25% available for RX buffers only. The reason is to prevent a
161  * situation where all buffers are full and a message is thus endlessly
162  * retried because the response could never be processed.
163  */
164 static struct nvec_msg *nvec_msg_alloc(struct nvec_chip *nvec,
165                                        enum nvec_msg_category category)
166 {
167         int i = (category == NVEC_MSG_TX) ? (NVEC_POOL_SIZE / 4) : 0;
168
169         for (; i < NVEC_POOL_SIZE; i++) {
170                 if (atomic_xchg(&nvec->msg_pool[i].used, 1) == 0) {
171                         dev_vdbg(nvec->dev, "INFO: Allocate %i\n", i);
172                         return &nvec->msg_pool[i];
173                 }
174         }
175
176         dev_err(nvec->dev, "could not allocate %s buffer\n",
177                 (category == NVEC_MSG_TX) ? "TX" : "RX");
178
179         return NULL;
180 }
181
182 /**
183  * nvec_msg_free:
184  * @nvec: A &struct nvec_chip
185  * @msg:  A message (must be allocated by nvec_msg_alloc() and belong to @nvec)
186  *
187  * Free the given message
188  */
189 inline void nvec_msg_free(struct nvec_chip *nvec, struct nvec_msg *msg)
190 {
191         if (msg != &nvec->tx_scratch)
192                 dev_vdbg(nvec->dev, "INFO: Free %ti\n", msg - nvec->msg_pool);
193         atomic_set(&msg->used, 0);
194 }
195 EXPORT_SYMBOL_GPL(nvec_msg_free);
196
197 /**
198  * nvec_msg_is_event - Return %true if @msg is an event
199  * @msg: A message
200  */
201 static bool nvec_msg_is_event(struct nvec_msg *msg)
202 {
203         return msg->data[0] >> 7;
204 }
205
206 /**
207  * nvec_msg_size - Get the size of a message
208  * @msg: The message to get the size for
209  *
210  * This only works for received messages, not for outgoing messages.
211  */
212 static size_t nvec_msg_size(struct nvec_msg *msg)
213 {
214         bool is_event = nvec_msg_is_event(msg);
215         int event_length = (msg->data[0] & 0x60) >> 5;
216
217         /* for variable size, payload size in byte 1 + count (1) + cmd (1) */
218         if (!is_event || event_length == NVEC_VAR_SIZE)
219                 return (msg->pos || msg->size) ? (msg->data[1] + 2) : 0;
220         else if (event_length == NVEC_2BYTES)
221                 return 2;
222         else if (event_length == NVEC_3BYTES)
223                 return 3;
224         else
225                 return 0;
226 }
227
228 /**
229  * nvec_gpio_set_value - Set the GPIO value
230  * @nvec: A &struct nvec_chip
231  * @value: The value to write (0 or 1)
232  *
233  * Like gpio_set_value(), but generating debugging information
234  */
235 static void nvec_gpio_set_value(struct nvec_chip *nvec, int value)
236 {
237         dev_dbg(nvec->dev, "GPIO changed from %u to %u\n",
238                 gpio_get_value(nvec->gpio), value);
239         gpio_set_value(nvec->gpio, value);
240 }
241
242 /**
243  * nvec_write_async - Asynchronously write a message to NVEC
244  * @nvec: An nvec_chip instance
245  * @data: The message data, starting with the request type
246  * @size: The size of @data
247  *
248  * Queue a single message to be transferred to the embedded controller
249  * and return immediately.
250  *
251  * Returns: 0 on success, a negative error code on failure. If a failure
252  * occured, the nvec driver may print an error.
253  */
254 int nvec_write_async(struct nvec_chip *nvec, const unsigned char *data,
255                         short size)
256 {
257         struct nvec_msg *msg;
258         unsigned long flags;
259
260         msg = nvec_msg_alloc(nvec, NVEC_MSG_TX);
261
262         if (msg == NULL)
263                 return -ENOMEM;
264
265         msg->data[0] = size;
266         memcpy(msg->data + 1, data, size);
267         msg->size = size + 1;
268
269         spin_lock_irqsave(&nvec->tx_lock, flags);
270         list_add_tail(&msg->node, &nvec->tx_data);
271         spin_unlock_irqrestore(&nvec->tx_lock, flags);
272
273         schedule_work(&nvec->tx_work);
274
275         return 0;
276 }
277 EXPORT_SYMBOL(nvec_write_async);
278
279 /**
280  * nvec_write_sync - Write a message to nvec and read the response
281  * @nvec: An &struct nvec_chip
282  * @data: The data to write
283  * @size: The size of @data
284  *
285  * This is similar to nvec_write_async(), but waits for the
286  * request to be answered before returning. This function
287  * uses a mutex and can thus not be called from e.g.
288  * interrupt handlers.
289  *
290  * Returns: A pointer to the response message on success,
291  * %NULL on failure. Free with nvec_msg_free() once no longer
292  * used.
293  */
294 struct nvec_msg *nvec_write_sync(struct nvec_chip *nvec,
295                 const unsigned char *data, short size)
296 {
297         struct nvec_msg *msg;
298
299         mutex_lock(&nvec->sync_write_mutex);
300
301         nvec->sync_write_pending = (data[1] << 8) + data[0];
302
303         if (nvec_write_async(nvec, data, size) < 0) {
304                 mutex_unlock(&nvec->sync_write_mutex);
305                 return NULL;
306         }
307
308         dev_dbg(nvec->dev, "nvec_sync_write: 0x%04x\n",
309                                         nvec->sync_write_pending);
310         if (!(wait_for_completion_timeout(&nvec->sync_write,
311                                 msecs_to_jiffies(2000)))) {
312                 dev_warn(nvec->dev, "timeout waiting for sync write to complete\n");
313                 mutex_unlock(&nvec->sync_write_mutex);
314                 return NULL;
315         }
316
317         dev_dbg(nvec->dev, "nvec_sync_write: pong!\n");
318
319         msg = nvec->last_sync_msg;
320
321         mutex_unlock(&nvec->sync_write_mutex);
322
323         return msg;
324 }
325 EXPORT_SYMBOL(nvec_write_sync);
326
327 /**
328  * nvec_toggle_global_events - enables or disables global event reporting
329  * @nvec: nvec handle
330  * @state: true for enable, false for disable
331  *
332  * This switches on/off global event reports by the embedded controller.
333  */
334 static void nvec_toggle_global_events(struct nvec_chip *nvec, bool state)
335 {
336         unsigned char global_events[] = { NVEC_SLEEP, GLOBAL_EVENTS, state };
337
338         nvec_write_async(nvec, global_events, 3);
339 }
340
341 /**
342  * nvec_event_mask - fill the command string with event bitfield
343  * ev: points to event command string
344  * mask: bit to insert into the event mask
345  *
346  * Configure event command expects a 32 bit bitfield which describes
347  * which events to enable. The bitfield has the following structure
348  * (from highest byte to lowest):
349  *      system state bits 7-0
350  *      system state bits 15-8
351  *      oem system state bits 7-0
352  *      oem system state bits 15-8
353  */
354 static void nvec_event_mask(char *ev, u32 mask)
355 {
356         ev[3] = mask >> 16 && 0xff;
357         ev[4] = mask >> 24 && 0xff;
358         ev[5] = mask >> 0  && 0xff;
359         ev[6] = mask >> 8  && 0xff;
360 }
361
362 /**
363  * nvec_request_master - Process outgoing messages
364  * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip)
365  *
366  * Processes all outgoing requests by sending the request and awaiting the
367  * response, then continuing with the next request. Once a request has a
368  * matching response, it will be freed and removed from the list.
369  */
370 static void nvec_request_master(struct work_struct *work)
371 {
372         struct nvec_chip *nvec = container_of(work, struct nvec_chip, tx_work);
373         unsigned long flags;
374         long err;
375         struct nvec_msg *msg;
376
377         spin_lock_irqsave(&nvec->tx_lock, flags);
378         while (!list_empty(&nvec->tx_data)) {
379                 msg = list_first_entry(&nvec->tx_data, struct nvec_msg, node);
380                 spin_unlock_irqrestore(&nvec->tx_lock, flags);
381                 nvec_gpio_set_value(nvec, 0);
382                 err = wait_for_completion_interruptible_timeout(
383                                 &nvec->ec_transfer, msecs_to_jiffies(5000));
384
385                 if (err == 0) {
386                         dev_warn(nvec->dev, "timeout waiting for ec transfer\n");
387                         nvec_gpio_set_value(nvec, 1);
388                         msg->pos = 0;
389                 }
390
391                 spin_lock_irqsave(&nvec->tx_lock, flags);
392
393                 if (err > 0) {
394                         list_del_init(&msg->node);
395                         nvec_msg_free(nvec, msg);
396                 }
397         }
398         spin_unlock_irqrestore(&nvec->tx_lock, flags);
399 }
400
401 /**
402  * parse_msg - Print some information and call the notifiers on an RX message
403  * @nvec: A &struct nvec_chip
404  * @msg: A message received by @nvec
405  *
406  * Paarse some pieces of the message and then call the chain of notifiers
407  * registered via nvec_register_notifier.
408  */
409 static int parse_msg(struct nvec_chip *nvec, struct nvec_msg *msg)
410 {
411         if ((msg->data[0] & 1 << 7) == 0 && msg->data[3]) {
412                 dev_err(nvec->dev, "ec responded %*ph\n", 4, msg->data);
413                 return -EINVAL;
414         }
415
416         if ((msg->data[0] >> 7) == 1 && (msg->data[0] & 0x0f) == 5)
417                 print_hex_dump(KERN_WARNING, "ec system event ",
418                                 DUMP_PREFIX_NONE, 16, 1, msg->data,
419                                 msg->data[1] + 2, true);
420
421         atomic_notifier_call_chain(&nvec->notifier_list, msg->data[0] & 0x8f,
422                                    msg->data);
423
424         return 0;
425 }
426
427 /**
428  * nvec_dispatch - Process messages received from the EC
429  * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip)
430  *
431  * Process messages previously received from the EC and put into the RX
432  * queue of the &struct nvec_chip instance associated with @work.
433  */
434 static void nvec_dispatch(struct work_struct *work)
435 {
436         struct nvec_chip *nvec = container_of(work, struct nvec_chip, rx_work);
437         unsigned long flags;
438         struct nvec_msg *msg;
439
440         spin_lock_irqsave(&nvec->rx_lock, flags);
441         while (!list_empty(&nvec->rx_data)) {
442                 msg = list_first_entry(&nvec->rx_data, struct nvec_msg, node);
443                 list_del_init(&msg->node);
444                 spin_unlock_irqrestore(&nvec->rx_lock, flags);
445
446                 if (nvec->sync_write_pending ==
447                       (msg->data[2] << 8) + msg->data[0]) {
448                         dev_dbg(nvec->dev, "sync write completed!\n");
449                         nvec->sync_write_pending = 0;
450                         nvec->last_sync_msg = msg;
451                         complete(&nvec->sync_write);
452                 } else {
453                         parse_msg(nvec, msg);
454                         nvec_msg_free(nvec, msg);
455                 }
456                 spin_lock_irqsave(&nvec->rx_lock, flags);
457         }
458         spin_unlock_irqrestore(&nvec->rx_lock, flags);
459 }
460
461 /**
462  * nvec_tx_completed - Complete the current transfer
463  * @nvec: A &struct nvec_chip
464  *
465  * This is called when we have received an END_TRANS on a TX transfer.
466  */
467 static void nvec_tx_completed(struct nvec_chip *nvec)
468 {
469         /* We got an END_TRANS, let's skip this, maybe there's an event */
470         if (nvec->tx->pos != nvec->tx->size) {
471                 dev_err(nvec->dev, "premature END_TRANS, resending\n");
472                 nvec->tx->pos = 0;
473                 nvec_gpio_set_value(nvec, 0);
474         } else {
475                 nvec->state = 0;
476         }
477 }
478
479 /**
480  * nvec_rx_completed - Complete the current transfer
481  * @nvec: A &struct nvec_chip
482  *
483  * This is called when we have received an END_TRANS on a RX transfer.
484  */
485 static void nvec_rx_completed(struct nvec_chip *nvec)
486 {
487         if (nvec->rx->pos != nvec_msg_size(nvec->rx)) {
488                 dev_err(nvec->dev, "RX incomplete: Expected %u bytes, got %u\n",
489                            (uint) nvec_msg_size(nvec->rx),
490                            (uint) nvec->rx->pos);
491
492                 nvec_msg_free(nvec, nvec->rx);
493                 nvec->state = 0;
494
495                 /* Battery quirk - Often incomplete, and likes to crash */
496                 if (nvec->rx->data[0] == NVEC_BAT)
497                         complete(&nvec->ec_transfer);
498
499                 return;
500         }
501
502         spin_lock(&nvec->rx_lock);
503
504         /* add the received data to the work list
505            and move the ring buffer pointer to the next entry */
506         list_add_tail(&nvec->rx->node, &nvec->rx_data);
507
508         spin_unlock(&nvec->rx_lock);
509
510         nvec->state = 0;
511
512         if (!nvec_msg_is_event(nvec->rx))
513                 complete(&nvec->ec_transfer);
514
515         schedule_work(&nvec->rx_work);
516 }
517
518 /**
519  * nvec_invalid_flags - Send an error message about invalid flags and jump
520  * @nvec: The nvec device
521  * @status: The status flags
522  * @reset: Whether we shall jump to state 0.
523  */
524 static void nvec_invalid_flags(struct nvec_chip *nvec, unsigned int status,
525                                bool reset)
526 {
527         dev_err(nvec->dev, "unexpected status flags 0x%02x during state %i\n",
528                 status, nvec->state);
529         if (reset)
530                 nvec->state = 0;
531 }
532
533 /**
534  * nvec_tx_set - Set the message to transfer (nvec->tx)
535  * @nvec: A &struct nvec_chip
536  *
537  * Gets the first entry from the tx_data list of @nvec and sets the
538  * tx member to it. If the tx_data list is empty, this uses the
539  * tx_scratch message to send a no operation message.
540  */
541 static void nvec_tx_set(struct nvec_chip *nvec)
542 {
543         spin_lock(&nvec->tx_lock);
544         if (list_empty(&nvec->tx_data)) {
545                 dev_err(nvec->dev, "empty tx - sending no-op\n");
546                 memcpy(nvec->tx_scratch.data, "\x02\x07\x02", 3);
547                 nvec->tx_scratch.size = 3;
548                 nvec->tx_scratch.pos = 0;
549                 nvec->tx = &nvec->tx_scratch;
550                 list_add_tail(&nvec->tx->node, &nvec->tx_data);
551         } else {
552                 nvec->tx = list_first_entry(&nvec->tx_data, struct nvec_msg,
553                                             node);
554                 nvec->tx->pos = 0;
555         }
556         spin_unlock(&nvec->tx_lock);
557
558         dev_dbg(nvec->dev, "Sending message of length %u, command 0x%x\n",
559                 (uint)nvec->tx->size, nvec->tx->data[1]);
560 }
561
562 /**
563  * nvec_interrupt - Interrupt handler
564  * @irq: The IRQ
565  * @dev: The nvec device
566  *
567  * Interrupt handler that fills our RX buffers and empties our TX
568  * buffers. This uses a finite state machine with ridiculous amounts
569  * of error checking, in order to be fairly reliable.
570  */
571 static irqreturn_t nvec_interrupt(int irq, void *dev)
572 {
573         unsigned long status;
574         unsigned int received = 0;
575         unsigned char to_send = 0xff;
576         const unsigned long irq_mask = I2C_SL_IRQ | END_TRANS | RCVD | RNW;
577         struct nvec_chip *nvec = dev;
578         unsigned int state = nvec->state;
579
580         status = readl(nvec->base + I2C_SL_STATUS);
581
582         /* Filter out some errors */
583         if ((status & irq_mask) == 0 && (status & ~irq_mask) != 0) {
584                 dev_err(nvec->dev, "unexpected irq mask %lx\n", status);
585                 return IRQ_HANDLED;
586         }
587         if ((status & I2C_SL_IRQ) == 0) {
588                 dev_err(nvec->dev, "Spurious IRQ\n");
589                 return IRQ_HANDLED;
590         }
591
592         /* The EC did not request a read, so it send us something, read it */
593         if ((status & RNW) == 0) {
594                 received = readl(nvec->base + I2C_SL_RCVD);
595                 if (status & RCVD)
596                         writel(0, nvec->base + I2C_SL_RCVD);
597         }
598
599         if (status == (I2C_SL_IRQ | RCVD))
600                 nvec->state = 0;
601
602         switch (nvec->state) {
603         case 0:         /* Verify that its a transfer start, the rest later */
604                 if (status != (I2C_SL_IRQ | RCVD))
605                         nvec_invalid_flags(nvec, status, false);
606                 break;
607         case 1:         /* command byte */
608                 if (status != I2C_SL_IRQ) {
609                         nvec_invalid_flags(nvec, status, true);
610                 } else {
611                         nvec->rx = nvec_msg_alloc(nvec, NVEC_MSG_RX);
612                         /* Should not happen in a normal world */
613                         if (unlikely(nvec->rx == NULL)) {
614                                 nvec->state = 0;
615                                 break;
616                         }
617                         nvec->rx->data[0] = received;
618                         nvec->rx->pos = 1;
619                         nvec->state = 2;
620                 }
621                 break;
622         case 2:         /* first byte after command */
623                 if (status == (I2C_SL_IRQ | RNW | RCVD)) {
624                         udelay(33);
625                         if (nvec->rx->data[0] != 0x01) {
626                                 dev_err(nvec->dev,
627                                         "Read without prior read command\n");
628                                 nvec->state = 0;
629                                 break;
630                         }
631                         nvec_msg_free(nvec, nvec->rx);
632                         nvec->state = 3;
633                         nvec_tx_set(nvec);
634                         BUG_ON(nvec->tx->size < 1);
635                         to_send = nvec->tx->data[0];
636                         nvec->tx->pos = 1;
637                 } else if (status == (I2C_SL_IRQ)) {
638                         BUG_ON(nvec->rx == NULL);
639                         nvec->rx->data[1] = received;
640                         nvec->rx->pos = 2;
641                         nvec->state = 4;
642                 } else {
643                         nvec_invalid_flags(nvec, status, true);
644                 }
645                 break;
646         case 3:         /* EC does a block read, we transmit data */
647                 if (status & END_TRANS) {
648                         nvec_tx_completed(nvec);
649                 } else if ((status & RNW) == 0 || (status & RCVD)) {
650                         nvec_invalid_flags(nvec, status, true);
651                 } else if (nvec->tx && nvec->tx->pos < nvec->tx->size) {
652                         to_send = nvec->tx->data[nvec->tx->pos++];
653                 } else {
654                         dev_err(nvec->dev, "tx buffer underflow on %p (%u > %u)\n",
655                                 nvec->tx,
656                                 (uint) (nvec->tx ? nvec->tx->pos : 0),
657                                 (uint) (nvec->tx ? nvec->tx->size : 0));
658                         nvec->state = 0;
659                 }
660                 break;
661         case 4:         /* EC does some write, we read the data */
662                 if ((status & (END_TRANS | RNW)) == END_TRANS)
663                         nvec_rx_completed(nvec);
664                 else if (status & (RNW | RCVD))
665                         nvec_invalid_flags(nvec, status, true);
666                 else if (nvec->rx && nvec->rx->pos < NVEC_MSG_SIZE)
667                         nvec->rx->data[nvec->rx->pos++] = received;
668                 else
669                         dev_err(nvec->dev,
670                                 "RX buffer overflow on %p: "
671                                 "Trying to write byte %u of %u\n",
672                                 nvec->rx, nvec->rx->pos, NVEC_MSG_SIZE);
673                 break;
674         default:
675                 nvec->state = 0;
676         }
677
678         /* If we are told that a new transfer starts, verify it */
679         if ((status & (RCVD | RNW)) == RCVD) {
680                 if (received != nvec->i2c_addr)
681                         dev_err(nvec->dev,
682                         "received address 0x%02x, expected 0x%02x\n",
683                         received, nvec->i2c_addr);
684                 nvec->state = 1;
685         }
686
687         /* Send data if requested, but not on end of transmission */
688         if ((status & (RNW | END_TRANS)) == RNW)
689                 writel(to_send, nvec->base + I2C_SL_RCVD);
690
691         /* If we have send the first byte */
692         if (status == (I2C_SL_IRQ | RNW | RCVD))
693                 nvec_gpio_set_value(nvec, 1);
694
695         dev_dbg(nvec->dev,
696                 "Handled: %s 0x%02x, %s 0x%02x in state %u [%s%s%s]\n",
697                 (status & RNW) == 0 ? "received" : "R=",
698                 received,
699                 (status & (RNW | END_TRANS)) ? "sent" : "S=",
700                 to_send,
701                 state,
702                 status & END_TRANS ? " END_TRANS" : "",
703                 status & RCVD ? " RCVD" : "",
704                 status & RNW ? " RNW" : "");
705
706
707         /*
708          * TODO: A correct fix needs to be found for this.
709          *
710          * We experience less incomplete messages with this delay than without
711          * it, but we don't know why. Help is appreciated.
712          */
713         udelay(100);
714
715         return IRQ_HANDLED;
716 }
717
718 static void tegra_init_i2c_slave(struct nvec_chip *nvec)
719 {
720         u32 val;
721
722         clk_prepare_enable(nvec->i2c_clk);
723
724         tegra_periph_reset_assert(nvec->i2c_clk);
725         udelay(2);
726         tegra_periph_reset_deassert(nvec->i2c_clk);
727
728         val = I2C_CNFG_NEW_MASTER_SFM | I2C_CNFG_PACKET_MODE_EN |
729             (0x2 << I2C_CNFG_DEBOUNCE_CNT_SHIFT);
730         writel(val, nvec->base + I2C_CNFG);
731
732         clk_set_rate(nvec->i2c_clk, 8 * 80000);
733
734         writel(I2C_SL_NEWSL, nvec->base + I2C_SL_CNFG);
735         writel(0x1E, nvec->base + I2C_SL_DELAY_COUNT);
736
737         writel(nvec->i2c_addr>>1, nvec->base + I2C_SL_ADDR1);
738         writel(0, nvec->base + I2C_SL_ADDR2);
739
740         enable_irq(nvec->irq);
741
742         clk_disable_unprepare(nvec->i2c_clk);
743 }
744
745 #ifdef CONFIG_PM_SLEEP
746 static void nvec_disable_i2c_slave(struct nvec_chip *nvec)
747 {
748         disable_irq(nvec->irq);
749         writel(I2C_SL_NEWSL | I2C_SL_NACK, nvec->base + I2C_SL_CNFG);
750         clk_disable_unprepare(nvec->i2c_clk);
751 }
752 #endif
753
754 static void nvec_power_off(void)
755 {
756         char ap_pwr_down[] = { NVEC_SLEEP, AP_PWR_DOWN };
757
758         nvec_toggle_global_events(nvec_power_handle, false);
759         nvec_write_async(nvec_power_handle, ap_pwr_down, 2);
760 }
761
762 static int tegra_nvec_probe(struct platform_device *pdev)
763 {
764         int err, ret;
765         struct clk *i2c_clk;
766         struct nvec_platform_data *pdata = pdev->dev.platform_data;
767         struct nvec_chip *nvec;
768         struct nvec_msg *msg;
769         struct resource *res;
770         void __iomem *base;
771         char    get_firmware_version[] = { NVEC_CNTL, GET_FIRMWARE_VERSION },
772                 unmute_speakers[] = { NVEC_OEM0, 0x10, 0x59, 0x95 },
773                 enable_event[7] = { NVEC_SYS, CNF_EVENT_REPORTING, true };
774
775         nvec = devm_kzalloc(&pdev->dev, sizeof(struct nvec_chip), GFP_KERNEL);
776         if (nvec == NULL) {
777                 dev_err(&pdev->dev, "failed to reserve memory\n");
778                 return -ENOMEM;
779         }
780         platform_set_drvdata(pdev, nvec);
781         nvec->dev = &pdev->dev;
782
783         if (pdata) {
784                 nvec->gpio = pdata->gpio;
785                 nvec->i2c_addr = pdata->i2c_addr;
786         } else if (nvec->dev->of_node) {
787                 nvec->gpio = of_get_named_gpio(nvec->dev->of_node,
788                                         "request-gpios", 0);
789                 if (nvec->gpio < 0) {
790                         dev_err(&pdev->dev, "no gpio specified");
791                         return -ENODEV;
792                 }
793                 if (of_property_read_u32(nvec->dev->of_node,
794                                         "slave-addr", &nvec->i2c_addr)) {
795                         dev_err(&pdev->dev, "no i2c address specified");
796                         return -ENODEV;
797                 }
798         } else {
799                 dev_err(&pdev->dev, "no platform data\n");
800                 return -ENODEV;
801         }
802
803         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
804         if (!res) {
805                 dev_err(&pdev->dev, "no mem resource?\n");
806                 return -ENODEV;
807         }
808
809         base = devm_ioremap_resource(&pdev->dev, res);
810         if (IS_ERR(base))
811                 return PTR_ERR(base);
812
813         res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
814         if (!res) {
815                 dev_err(&pdev->dev, "no irq resource?\n");
816                 return -ENODEV;
817         }
818
819         i2c_clk = clk_get_sys("tegra-i2c.2", "div-clk");
820         if (IS_ERR(i2c_clk)) {
821                 dev_err(nvec->dev, "failed to get controller clock\n");
822                 return -ENODEV;
823         }
824
825         nvec->base = base;
826         nvec->irq = res->start;
827         nvec->i2c_clk = i2c_clk;
828         nvec->rx = &nvec->msg_pool[0];
829
830         ATOMIC_INIT_NOTIFIER_HEAD(&nvec->notifier_list);
831
832         init_completion(&nvec->sync_write);
833         init_completion(&nvec->ec_transfer);
834         mutex_init(&nvec->sync_write_mutex);
835         spin_lock_init(&nvec->tx_lock);
836         spin_lock_init(&nvec->rx_lock);
837         INIT_LIST_HEAD(&nvec->rx_data);
838         INIT_LIST_HEAD(&nvec->tx_data);
839         INIT_WORK(&nvec->rx_work, nvec_dispatch);
840         INIT_WORK(&nvec->tx_work, nvec_request_master);
841
842         err = devm_gpio_request_one(&pdev->dev, nvec->gpio, GPIOF_OUT_INIT_HIGH,
843                                         "nvec gpio");
844         if (err < 0) {
845                 dev_err(nvec->dev, "couldn't request gpio\n");
846                 return -ENODEV;
847         }
848
849         err = devm_request_irq(&pdev->dev, nvec->irq, nvec_interrupt, 0,
850                                 "nvec", nvec);
851         if (err) {
852                 dev_err(nvec->dev, "couldn't request irq\n");
853                 return -ENODEV;
854         }
855         disable_irq(nvec->irq);
856
857         tegra_init_i2c_slave(nvec);
858
859         clk_prepare_enable(i2c_clk);
860
861
862         /* enable event reporting */
863         nvec_toggle_global_events(nvec, true);
864
865         nvec->nvec_status_notifier.notifier_call = nvec_status_notifier;
866         nvec_register_notifier(nvec, &nvec->nvec_status_notifier, 0);
867
868         nvec_power_handle = nvec;
869         pm_power_off = nvec_power_off;
870
871         /* Get Firmware Version */
872         msg = nvec_write_sync(nvec, get_firmware_version, 2);
873
874         if (msg) {
875                 dev_warn(nvec->dev, "ec firmware version %02x.%02x.%02x / %02x\n",
876                         msg->data[4], msg->data[5], msg->data[6], msg->data[7]);
877
878                 nvec_msg_free(nvec, msg);
879         }
880
881         ret = mfd_add_devices(nvec->dev, -1, nvec_devices,
882                               ARRAY_SIZE(nvec_devices), base, 0, NULL);
883         if (ret)
884                 dev_err(nvec->dev, "error adding subdevices\n");
885
886         /* unmute speakers? */
887         nvec_write_async(nvec, unmute_speakers, 4);
888
889         /* enable lid switch event */
890         nvec_event_mask(enable_event, LID_SWITCH);
891         nvec_write_async(nvec, enable_event, 7);
892
893         /* enable power button event */
894         nvec_event_mask(enable_event, PWR_BUTTON);
895         nvec_write_async(nvec, enable_event, 7);
896
897         return 0;
898 }
899
900 static int tegra_nvec_remove(struct platform_device *pdev)
901 {
902         struct nvec_chip *nvec = platform_get_drvdata(pdev);
903
904         nvec_toggle_global_events(nvec, false);
905         mfd_remove_devices(nvec->dev);
906         cancel_work_sync(&nvec->rx_work);
907         cancel_work_sync(&nvec->tx_work);
908
909         return 0;
910 }
911
912 #ifdef CONFIG_PM_SLEEP
913 static int nvec_suspend(struct device *dev)
914 {
915         struct platform_device *pdev = to_platform_device(dev);
916         struct nvec_chip *nvec = platform_get_drvdata(pdev);
917         struct nvec_msg *msg;
918         char ap_suspend[] = { NVEC_SLEEP, AP_SUSPEND };
919
920         dev_dbg(nvec->dev, "suspending\n");
921
922         /* keep these sync or you'll break suspend */
923         nvec_toggle_global_events(nvec, false);
924
925         msg = nvec_write_sync(nvec, ap_suspend, sizeof(ap_suspend));
926         nvec_msg_free(nvec, msg);
927
928         nvec_disable_i2c_slave(nvec);
929
930         return 0;
931 }
932
933 static int nvec_resume(struct device *dev)
934 {
935         struct platform_device *pdev = to_platform_device(dev);
936         struct nvec_chip *nvec = platform_get_drvdata(pdev);
937
938         dev_dbg(nvec->dev, "resuming\n");
939         tegra_init_i2c_slave(nvec);
940         nvec_toggle_global_events(nvec, true);
941
942         return 0;
943 }
944 #endif
945
946 static const SIMPLE_DEV_PM_OPS(nvec_pm_ops, nvec_suspend, nvec_resume);
947
948 /* Match table for of_platform binding */
949 static const struct of_device_id nvidia_nvec_of_match[] = {
950         { .compatible = "nvidia,nvec", },
951         {},
952 };
953 MODULE_DEVICE_TABLE(of, nvidia_nvec_of_match);
954
955 static struct platform_driver nvec_device_driver = {
956         .probe   = tegra_nvec_probe,
957         .remove  = tegra_nvec_remove,
958         .driver  = {
959                 .name = "nvec",
960                 .owner = THIS_MODULE,
961                 .pm = &nvec_pm_ops,
962                 .of_match_table = nvidia_nvec_of_match,
963         }
964 };
965
966 module_platform_driver(nvec_device_driver);
967
968 MODULE_ALIAS("platform:nvec");
969 MODULE_DESCRIPTION("NVIDIA compliant embedded controller interface");
970 MODULE_AUTHOR("Marc Dietrich <marvin24@gmx.de>");
971 MODULE_LICENSE("GPL");