1971bcfcaSGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0
2162c7d8cSMarc Dietrich /*
3162c7d8cSMarc Dietrich * NVEC: NVIDIA compliant embedded controller interface
4162c7d8cSMarc Dietrich *
5162c7d8cSMarc Dietrich * Copyright (C) 2011 The AC100 Kernel Team <ac100@lists.lauchpad.net>
6162c7d8cSMarc Dietrich *
7162c7d8cSMarc Dietrich * Authors: Pierre-Hugues Husson <phhusson@free.fr>
8162c7d8cSMarc Dietrich * Ilya Petrov <ilya.muromec@gmail.com>
9162c7d8cSMarc Dietrich * Marc Dietrich <marvin24@gmx.de>
10791c4a64SJulian Andres Klode * Julian Andres Klode <jak@jak-linux.org>
1132890b98SMarc Dietrich */
1232890b98SMarc Dietrich
1312b5a55dSJulian Andres Klode #include <linux/kernel.h>
143b769eddSMarc Dietrich #include <linux/module.h>
150b1076c4SJulian Andres Klode #include <linux/atomic.h>
1612b5a55dSJulian Andres Klode #include <linux/clk.h>
1732890b98SMarc Dietrich #include <linux/completion.h>
1812b5a55dSJulian Andres Klode #include <linux/delay.h>
1912b5a55dSJulian Andres Klode #include <linux/err.h>
2040fbffd9SMarc Dietrich #include <linux/gpio/consumer.h>
2132890b98SMarc Dietrich #include <linux/interrupt.h>
22162c7d8cSMarc Dietrich #include <linux/io.h>
2332890b98SMarc Dietrich #include <linux/irq.h>
247990b0d7SMarc Dietrich #include <linux/of.h>
2532890b98SMarc Dietrich #include <linux/list.h>
2612b5a55dSJulian Andres Klode #include <linux/mfd/core.h>
2712b5a55dSJulian Andres Klode #include <linux/mutex.h>
2832890b98SMarc Dietrich #include <linux/notifier.h>
2912b5a55dSJulian Andres Klode #include <linux/slab.h>
3012b5a55dSJulian Andres Klode #include <linux/spinlock.h>
3112b5a55dSJulian Andres Klode #include <linux/workqueue.h>
32162c7d8cSMarc Dietrich
3332890b98SMarc Dietrich #include "nvec.h"
3432890b98SMarc Dietrich
35391d2fa9SJulian Andres Klode #define I2C_CNFG 0x00
36d09c2a84SLaura Garcia Liebana #define I2C_CNFG_PACKET_MODE_EN BIT(10)
37d09c2a84SLaura Garcia Liebana #define I2C_CNFG_NEW_MASTER_SFM BIT(11)
38391d2fa9SJulian Andres Klode #define I2C_CNFG_DEBOUNCE_CNT_SHIFT 12
39391d2fa9SJulian Andres Klode
40391d2fa9SJulian Andres Klode #define I2C_SL_CNFG 0x20
41d09c2a84SLaura Garcia Liebana #define I2C_SL_NEWSL BIT(2)
42d09c2a84SLaura Garcia Liebana #define I2C_SL_NACK BIT(1)
43d09c2a84SLaura Garcia Liebana #define I2C_SL_RESP BIT(0)
44d09c2a84SLaura Garcia Liebana #define I2C_SL_IRQ BIT(3)
45d09c2a84SLaura Garcia Liebana #define END_TRANS BIT(4)
46d09c2a84SLaura Garcia Liebana #define RCVD BIT(2)
47d09c2a84SLaura Garcia Liebana #define RNW BIT(1)
48391d2fa9SJulian Andres Klode
49391d2fa9SJulian Andres Klode #define I2C_SL_RCVD 0x24
50391d2fa9SJulian Andres Klode #define I2C_SL_STATUS 0x28
51391d2fa9SJulian Andres Klode #define I2C_SL_ADDR1 0x2c
52391d2fa9SJulian Andres Klode #define I2C_SL_ADDR2 0x30
53391d2fa9SJulian Andres Klode #define I2C_SL_DELAY_COUNT 0x3c
54391d2fa9SJulian Andres Klode
55bb0590e2SJulian Andres Klode /**
56bb0590e2SJulian Andres Klode * enum nvec_msg_category - Message categories for nvec_msg_alloc()
57bb0590e2SJulian Andres Klode * @NVEC_MSG_RX: The message is an incoming message (from EC)
58bb0590e2SJulian Andres Klode * @NVEC_MSG_TX: The message is an outgoing message (to EC)
59bb0590e2SJulian Andres Klode */
60bb0590e2SJulian Andres Klode enum nvec_msg_category {
61bb0590e2SJulian Andres Klode NVEC_MSG_RX,
62bb0590e2SJulian Andres Klode NVEC_MSG_TX,
63bb0590e2SJulian Andres Klode };
64bb0590e2SJulian Andres Klode
65518945fbSMarc Dietrich enum nvec_sleep_subcmds {
66518945fbSMarc Dietrich GLOBAL_EVENTS,
6793eff83fSMarc Dietrich AP_PWR_DOWN,
6893eff83fSMarc Dietrich AP_SUSPEND,
69518945fbSMarc Dietrich };
70518945fbSMarc Dietrich
7193eff83fSMarc Dietrich #define CNF_EVENT_REPORTING 0x01
7293eff83fSMarc Dietrich #define GET_FIRMWARE_VERSION 0x15
7393eff83fSMarc Dietrich #define LID_SWITCH BIT(1)
7493eff83fSMarc Dietrich #define PWR_BUTTON BIT(15)
7532890b98SMarc Dietrich
7632890b98SMarc Dietrich static struct nvec_chip *nvec_power_handle;
7732890b98SMarc Dietrich
7828397dc9SGeert Uytterhoeven static const struct mfd_cell nvec_devices[] = {
79f686e9afSMarc Dietrich {
80f686e9afSMarc Dietrich .name = "nvec-kbd",
81f686e9afSMarc Dietrich },
82f686e9afSMarc Dietrich {
83f686e9afSMarc Dietrich .name = "nvec-mouse",
843ec69881SMarc Dietrich },
853ec69881SMarc Dietrich {
863ec69881SMarc Dietrich .name = "nvec-power",
873ec69881SMarc Dietrich .id = 0,
88f686e9afSMarc Dietrich },
89f686e9afSMarc Dietrich {
90f686e9afSMarc Dietrich .name = "nvec-power",
91f686e9afSMarc Dietrich .id = 1,
92f686e9afSMarc Dietrich },
93f686e9afSMarc Dietrich {
94ac562680SMarc Dietrich .name = "nvec-paz00",
9597cc2657SIlya Petrov },
96f686e9afSMarc Dietrich };
97f686e9afSMarc Dietrich
98bdf034d9SJulian Andres Klode /**
99bdf034d9SJulian Andres Klode * nvec_register_notifier - Register a notifier with nvec
100bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
101bdf034d9SJulian Andres Klode * @nb: The notifier block to register
102e950dd6bSLee Jones * @events: Unused
103bdf034d9SJulian Andres Klode *
104bdf034d9SJulian Andres Klode * Registers a notifier with @nvec. The notifier will be added to an atomic
105bdf034d9SJulian Andres Klode * notifier chain that is called for all received messages except those that
106bdf034d9SJulian Andres Klode * correspond to a request initiated by nvec_write_sync().
107bdf034d9SJulian Andres Klode */
nvec_register_notifier(struct nvec_chip * nvec,struct notifier_block * nb,unsigned int events)10832890b98SMarc Dietrich int nvec_register_notifier(struct nvec_chip *nvec, struct notifier_block *nb,
10932890b98SMarc Dietrich unsigned int events)
11032890b98SMarc Dietrich {
11132890b98SMarc Dietrich return atomic_notifier_chain_register(&nvec->notifier_list, nb);
11232890b98SMarc Dietrich }
11332890b98SMarc Dietrich EXPORT_SYMBOL_GPL(nvec_register_notifier);
11432890b98SMarc Dietrich
115bdf034d9SJulian Andres Klode /**
116111c1587SMarc Dietrich * nvec_unregister_notifier - Unregister a notifier with nvec
117111c1587SMarc Dietrich * @nvec: A &struct nvec_chip
118111c1587SMarc Dietrich * @nb: The notifier block to unregister
119111c1587SMarc Dietrich *
120111c1587SMarc Dietrich * Unregisters a notifier with @nvec. The notifier will be removed from the
121111c1587SMarc Dietrich * atomic notifier chain.
122111c1587SMarc Dietrich */
nvec_unregister_notifier(struct nvec_chip * nvec,struct notifier_block * nb)123111c1587SMarc Dietrich int nvec_unregister_notifier(struct nvec_chip *nvec, struct notifier_block *nb)
124111c1587SMarc Dietrich {
125111c1587SMarc Dietrich return atomic_notifier_chain_unregister(&nvec->notifier_list, nb);
126111c1587SMarc Dietrich }
127111c1587SMarc Dietrich EXPORT_SYMBOL_GPL(nvec_unregister_notifier);
128111c1587SMarc Dietrich
129e950dd6bSLee Jones /*
130bdf034d9SJulian Andres Klode * nvec_status_notifier - The final notifier
131bdf034d9SJulian Andres Klode *
132bdf034d9SJulian Andres Klode * Prints a message about control events not handled in the notifier
133bdf034d9SJulian Andres Klode * chain.
134bdf034d9SJulian Andres Klode */
nvec_status_notifier(struct notifier_block * nb,unsigned long event_type,void * data)135162c7d8cSMarc Dietrich static int nvec_status_notifier(struct notifier_block *nb,
136162c7d8cSMarc Dietrich unsigned long event_type, void *data)
13732890b98SMarc Dietrich {
13850d4656aSMarc Dietrich struct nvec_chip *nvec = container_of(nb, struct nvec_chip,
13950d4656aSMarc Dietrich nvec_status_notifier);
14060d0ed1cSJanani Ravichandran unsigned char *msg = data;
14132890b98SMarc Dietrich
14232890b98SMarc Dietrich if (event_type != NVEC_CNTL)
14332890b98SMarc Dietrich return NOTIFY_DONE;
14432890b98SMarc Dietrich
14550d4656aSMarc Dietrich dev_warn(nvec->dev, "unhandled msg type %ld\n", event_type);
146a3a9aa1aSMarc Dietrich print_hex_dump(KERN_WARNING, "payload: ", DUMP_PREFIX_NONE, 16, 1,
147a3a9aa1aSMarc Dietrich msg, msg[1] + 2, true);
14832890b98SMarc Dietrich
14932890b98SMarc Dietrich return NOTIFY_OK;
15032890b98SMarc Dietrich }
15132890b98SMarc Dietrich
152bdf034d9SJulian Andres Klode /**
153bdf034d9SJulian Andres Klode * nvec_msg_alloc:
154bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
155bb0590e2SJulian Andres Klode * @category: Pool category, see &enum nvec_msg_category
156bdf034d9SJulian Andres Klode *
157bdf034d9SJulian Andres Klode * Allocate a single &struct nvec_msg object from the message pool of
158bdf034d9SJulian Andres Klode * @nvec. The result shall be passed to nvec_msg_free() if no longer
159bdf034d9SJulian Andres Klode * used.
160bb0590e2SJulian Andres Klode *
161bb0590e2SJulian Andres Klode * Outgoing messages are placed in the upper 75% of the pool, keeping the
162bb0590e2SJulian Andres Klode * lower 25% available for RX buffers only. The reason is to prevent a
163bb0590e2SJulian Andres Klode * situation where all buffers are full and a message is thus endlessly
164bb0590e2SJulian Andres Klode * retried because the response could never be processed.
165bdf034d9SJulian Andres Klode */
nvec_msg_alloc(struct nvec_chip * nvec,enum nvec_msg_category category)166bb0590e2SJulian Andres Klode static struct nvec_msg *nvec_msg_alloc(struct nvec_chip *nvec,
167bb0590e2SJulian Andres Klode enum nvec_msg_category category)
1680b1076c4SJulian Andres Klode {
169bb0590e2SJulian Andres Klode int i = (category == NVEC_MSG_TX) ? (NVEC_POOL_SIZE / 4) : 0;
1700b1076c4SJulian Andres Klode
171bb0590e2SJulian Andres Klode for (; i < NVEC_POOL_SIZE; i++) {
1720b1076c4SJulian Andres Klode if (atomic_xchg(&nvec->msg_pool[i].used, 1) == 0) {
1730b1076c4SJulian Andres Klode dev_vdbg(nvec->dev, "INFO: Allocate %i\n", i);
1740b1076c4SJulian Andres Klode return &nvec->msg_pool[i];
1750b1076c4SJulian Andres Klode }
1760b1076c4SJulian Andres Klode }
1770b1076c4SJulian Andres Klode
178bb0590e2SJulian Andres Klode dev_err(nvec->dev, "could not allocate %s buffer\n",
179bb0590e2SJulian Andres Klode (category == NVEC_MSG_TX) ? "TX" : "RX");
1800b1076c4SJulian Andres Klode
1810b1076c4SJulian Andres Klode return NULL;
1820b1076c4SJulian Andres Klode }
1830b1076c4SJulian Andres Klode
184bdf034d9SJulian Andres Klode /**
185bdf034d9SJulian Andres Klode * nvec_msg_free:
186bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
187bdf034d9SJulian Andres Klode * @msg: A message (must be allocated by nvec_msg_alloc() and belong to @nvec)
188bdf034d9SJulian Andres Klode *
189bdf034d9SJulian Andres Klode * Free the given message
190bdf034d9SJulian Andres Klode */
nvec_msg_free(struct nvec_chip * nvec,struct nvec_msg * msg)191705a4212SDenis Efremov void nvec_msg_free(struct nvec_chip *nvec, struct nvec_msg *msg)
1920b1076c4SJulian Andres Klode {
1937b770657SJulian Andres Klode if (msg != &nvec->tx_scratch)
1940b1076c4SJulian Andres Klode dev_vdbg(nvec->dev, "INFO: Free %ti\n", msg - nvec->msg_pool);
1950b1076c4SJulian Andres Klode atomic_set(&msg->used, 0);
1960b1076c4SJulian Andres Klode }
197198dd267SJulian Andres Klode EXPORT_SYMBOL_GPL(nvec_msg_free);
1980b1076c4SJulian Andres Klode
1998517e879SJulian Andres Klode /**
2008517e879SJulian Andres Klode * nvec_msg_is_event - Return %true if @msg is an event
2018517e879SJulian Andres Klode * @msg: A message
2028517e879SJulian Andres Klode */
nvec_msg_is_event(struct nvec_msg * msg)2038517e879SJulian Andres Klode static bool nvec_msg_is_event(struct nvec_msg *msg)
2048517e879SJulian Andres Klode {
2058517e879SJulian Andres Klode return msg->data[0] >> 7;
2068517e879SJulian Andres Klode }
2078517e879SJulian Andres Klode
2088517e879SJulian Andres Klode /**
2098517e879SJulian Andres Klode * nvec_msg_size - Get the size of a message
2108517e879SJulian Andres Klode * @msg: The message to get the size for
2118517e879SJulian Andres Klode *
2128517e879SJulian Andres Klode * This only works for received messages, not for outgoing messages.
2138517e879SJulian Andres Klode */
nvec_msg_size(struct nvec_msg * msg)2148517e879SJulian Andres Klode static size_t nvec_msg_size(struct nvec_msg *msg)
2158517e879SJulian Andres Klode {
2168517e879SJulian Andres Klode bool is_event = nvec_msg_is_event(msg);
2178517e879SJulian Andres Klode int event_length = (msg->data[0] & 0x60) >> 5;
2188517e879SJulian Andres Klode
2198517e879SJulian Andres Klode /* for variable size, payload size in byte 1 + count (1) + cmd (1) */
2208517e879SJulian Andres Klode if (!is_event || event_length == NVEC_VAR_SIZE)
2218517e879SJulian Andres Klode return (msg->pos || msg->size) ? (msg->data[1] + 2) : 0;
2228517e879SJulian Andres Klode else if (event_length == NVEC_2BYTES)
2238517e879SJulian Andres Klode return 2;
2248517e879SJulian Andres Klode else if (event_length == NVEC_3BYTES)
2258517e879SJulian Andres Klode return 3;
2268517e879SJulian Andres Klode return 0;
2278517e879SJulian Andres Klode }
2288517e879SJulian Andres Klode
229bdf034d9SJulian Andres Klode /**
230bdf034d9SJulian Andres Klode * nvec_gpio_set_value - Set the GPIO value
231bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
232bdf034d9SJulian Andres Klode * @value: The value to write (0 or 1)
233bdf034d9SJulian Andres Klode *
234bdf034d9SJulian Andres Klode * Like gpio_set_value(), but generating debugging information
235bdf034d9SJulian Andres Klode */
nvec_gpio_set_value(struct nvec_chip * nvec,int value)236e7c40851SJulian Andres Klode static void nvec_gpio_set_value(struct nvec_chip *nvec, int value)
237e7c40851SJulian Andres Klode {
238e7c40851SJulian Andres Klode dev_dbg(nvec->dev, "GPIO changed from %u to %u\n",
23940fbffd9SMarc Dietrich gpiod_get_value(nvec->gpiod), value);
24040fbffd9SMarc Dietrich gpiod_set_value(nvec->gpiod, value);
241e7c40851SJulian Andres Klode }
242e7c40851SJulian Andres Klode
243bdf034d9SJulian Andres Klode /**
244bdf034d9SJulian Andres Klode * nvec_write_async - Asynchronously write a message to NVEC
245bdf034d9SJulian Andres Klode * @nvec: An nvec_chip instance
246bdf034d9SJulian Andres Klode * @data: The message data, starting with the request type
247bdf034d9SJulian Andres Klode * @size: The size of @data
248bdf034d9SJulian Andres Klode *
249bdf034d9SJulian Andres Klode * Queue a single message to be transferred to the embedded controller
250bdf034d9SJulian Andres Klode * and return immediately.
251bdf034d9SJulian Andres Klode *
252bdf034d9SJulian Andres Klode * Returns: 0 on success, a negative error code on failure. If a failure
2539b872a74SGustavo A. R. Silva * occurred, the nvec driver may print an error.
254bdf034d9SJulian Andres Klode */
nvec_write_async(struct nvec_chip * nvec,const unsigned char * data,short size)2551b9bf629SJulian Andres Klode int nvec_write_async(struct nvec_chip *nvec, const unsigned char *data,
256162c7d8cSMarc Dietrich short size)
25732890b98SMarc Dietrich {
2580cab4cb8SJulian Andres Klode struct nvec_msg *msg;
2590cab4cb8SJulian Andres Klode unsigned long flags;
26032890b98SMarc Dietrich
261bb0590e2SJulian Andres Klode msg = nvec_msg_alloc(nvec, NVEC_MSG_TX);
262bb0590e2SJulian Andres Klode
263f05f33faSLaura Garcia Liebana if (!msg)
2641b9bf629SJulian Andres Klode return -ENOMEM;
2651b9bf629SJulian Andres Klode
26632890b98SMarc Dietrich msg->data[0] = size;
26732890b98SMarc Dietrich memcpy(msg->data + 1, data, size);
26832890b98SMarc Dietrich msg->size = size + 1;
26932890b98SMarc Dietrich
2700cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags);
27132890b98SMarc Dietrich list_add_tail(&msg->node, &nvec->tx_data);
2720cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags);
27332890b98SMarc Dietrich
274033d9959SLinus Torvalds schedule_work(&nvec->tx_work);
2751b9bf629SJulian Andres Klode
2761b9bf629SJulian Andres Klode return 0;
27732890b98SMarc Dietrich }
27832890b98SMarc Dietrich EXPORT_SYMBOL(nvec_write_async);
27932890b98SMarc Dietrich
280bdf034d9SJulian Andres Klode /**
281bdf034d9SJulian Andres Klode * nvec_write_sync - Write a message to nvec and read the response
282bdf034d9SJulian Andres Klode * @nvec: An &struct nvec_chip
283bdf034d9SJulian Andres Klode * @data: The data to write
284bdf034d9SJulian Andres Klode * @size: The size of @data
28573b37c91STomás Tormo * @msg: The response message received
286bdf034d9SJulian Andres Klode *
287bdf034d9SJulian Andres Klode * This is similar to nvec_write_async(), but waits for the
288bdf034d9SJulian Andres Klode * request to be answered before returning. This function
289bdf034d9SJulian Andres Klode * uses a mutex and can thus not be called from e.g.
290bdf034d9SJulian Andres Klode * interrupt handlers.
291bdf034d9SJulian Andres Klode *
29273b37c91STomás Tormo * Returns: 0 on success, a negative error code on failure.
293e6ac17deSRyan Kosta * The response message is returned in @msg. Shall be freed
29473b37c91STomás Tormo * with nvec_msg_free() once no longer used.
29573b37c91STomás Tormo *
296bdf034d9SJulian Andres Klode */
nvec_write_sync(struct nvec_chip * nvec,const unsigned char * data,short size,struct nvec_msg ** msg)29773b37c91STomás Tormo int nvec_write_sync(struct nvec_chip *nvec,
29873b37c91STomás Tormo const unsigned char *data, short size,
29973b37c91STomás Tormo struct nvec_msg **msg)
3000cab4cb8SJulian Andres Klode {
3010cab4cb8SJulian Andres Klode mutex_lock(&nvec->sync_write_mutex);
3020cab4cb8SJulian Andres Klode
30373b37c91STomás Tormo *msg = NULL;
3040cab4cb8SJulian Andres Klode nvec->sync_write_pending = (data[1] << 8) + data[0];
3051b9bf629SJulian Andres Klode
3064b8bf03dSMarc Dietrich if (nvec_write_async(nvec, data, size) < 0) {
3074b8bf03dSMarc Dietrich mutex_unlock(&nvec->sync_write_mutex);
30873b37c91STomás Tormo return -ENOMEM;
3094b8bf03dSMarc Dietrich }
3100cab4cb8SJulian Andres Klode
3110cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "nvec_sync_write: 0x%04x\n",
3120cab4cb8SJulian Andres Klode nvec->sync_write_pending);
3130cab4cb8SJulian Andres Klode if (!(wait_for_completion_timeout(&nvec->sync_write,
3140cab4cb8SJulian Andres Klode msecs_to_jiffies(2000)))) {
315a4fe05d5SLaura Garcia Liebana dev_warn(nvec->dev,
316a4fe05d5SLaura Garcia Liebana "timeout waiting for sync write to complete\n");
3170cab4cb8SJulian Andres Klode mutex_unlock(&nvec->sync_write_mutex);
31873b37c91STomás Tormo return -ETIMEDOUT;
3190cab4cb8SJulian Andres Klode }
3200cab4cb8SJulian Andres Klode
3210cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "nvec_sync_write: pong!\n");
3220cab4cb8SJulian Andres Klode
32373b37c91STomás Tormo *msg = nvec->last_sync_msg;
3240cab4cb8SJulian Andres Klode
3250cab4cb8SJulian Andres Klode mutex_unlock(&nvec->sync_write_mutex);
3260cab4cb8SJulian Andres Klode
32773b37c91STomás Tormo return 0;
3280cab4cb8SJulian Andres Klode }
3290cab4cb8SJulian Andres Klode EXPORT_SYMBOL(nvec_write_sync);
3300cab4cb8SJulian Andres Klode
331bdf034d9SJulian Andres Klode /**
332518945fbSMarc Dietrich * nvec_toggle_global_events - enables or disables global event reporting
333518945fbSMarc Dietrich * @nvec: nvec handle
334518945fbSMarc Dietrich * @state: true for enable, false for disable
335518945fbSMarc Dietrich *
336518945fbSMarc Dietrich * This switches on/off global event reports by the embedded controller.
337518945fbSMarc Dietrich */
nvec_toggle_global_events(struct nvec_chip * nvec,bool state)338518945fbSMarc Dietrich static void nvec_toggle_global_events(struct nvec_chip *nvec, bool state)
339518945fbSMarc Dietrich {
340518945fbSMarc Dietrich unsigned char global_events[] = { NVEC_SLEEP, GLOBAL_EVENTS, state };
341518945fbSMarc Dietrich
342518945fbSMarc Dietrich nvec_write_async(nvec, global_events, 3);
343518945fbSMarc Dietrich }
344518945fbSMarc Dietrich
345518945fbSMarc Dietrich /**
34693eff83fSMarc Dietrich * nvec_event_mask - fill the command string with event bitfield
347e950dd6bSLee Jones * @ev: points to event command string
348e950dd6bSLee Jones * @mask: bit to insert into the event mask
34993eff83fSMarc Dietrich *
35093eff83fSMarc Dietrich * Configure event command expects a 32 bit bitfield which describes
35193eff83fSMarc Dietrich * which events to enable. The bitfield has the following structure
35293eff83fSMarc Dietrich * (from highest byte to lowest):
35393eff83fSMarc Dietrich * system state bits 7-0
35493eff83fSMarc Dietrich * system state bits 15-8
35593eff83fSMarc Dietrich * oem system state bits 7-0
35693eff83fSMarc Dietrich * oem system state bits 15-8
35793eff83fSMarc Dietrich */
nvec_event_mask(char * ev,u32 mask)35893eff83fSMarc Dietrich static void nvec_event_mask(char *ev, u32 mask)
35993eff83fSMarc Dietrich {
360815fb010SWei Yongjun ev[3] = mask >> 16 & 0xff;
361815fb010SWei Yongjun ev[4] = mask >> 24 & 0xff;
362815fb010SWei Yongjun ev[5] = mask >> 0 & 0xff;
363815fb010SWei Yongjun ev[6] = mask >> 8 & 0xff;
36493eff83fSMarc Dietrich }
36593eff83fSMarc Dietrich
36693eff83fSMarc Dietrich /**
367bdf034d9SJulian Andres Klode * nvec_request_master - Process outgoing messages
368bdf034d9SJulian Andres Klode * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip)
369bdf034d9SJulian Andres Klode *
370bdf034d9SJulian Andres Klode * Processes all outgoing requests by sending the request and awaiting the
371bdf034d9SJulian Andres Klode * response, then continuing with the next request. Once a request has a
372bdf034d9SJulian Andres Klode * matching response, it will be freed and removed from the list.
373bdf034d9SJulian Andres Klode */
nvec_request_master(struct work_struct * work)37432890b98SMarc Dietrich static void nvec_request_master(struct work_struct *work)
37532890b98SMarc Dietrich {
37632890b98SMarc Dietrich struct nvec_chip *nvec = container_of(work, struct nvec_chip, tx_work);
3770cab4cb8SJulian Andres Klode unsigned long flags;
3780cab4cb8SJulian Andres Klode long err;
3790cab4cb8SJulian Andres Klode struct nvec_msg *msg;
38032890b98SMarc Dietrich
3810cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags);
3820cab4cb8SJulian Andres Klode while (!list_empty(&nvec->tx_data)) {
3830cab4cb8SJulian Andres Klode msg = list_first_entry(&nvec->tx_data, struct nvec_msg, node);
3840cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags);
3850cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 0);
3861b9a8d75SAyan Choudhary err = wait_for_completion_interruptible_timeout(&nvec->ec_transfer,
3871b9a8d75SAyan Choudhary msecs_to_jiffies(5000));
3880cab4cb8SJulian Andres Klode
3890cab4cb8SJulian Andres Klode if (err == 0) {
3900cab4cb8SJulian Andres Klode dev_warn(nvec->dev, "timeout waiting for ec transfer\n");
3910cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 1);
3920cab4cb8SJulian Andres Klode msg->pos = 0;
3930cab4cb8SJulian Andres Klode }
3940cab4cb8SJulian Andres Klode
3950cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags);
3960cab4cb8SJulian Andres Klode
3970cab4cb8SJulian Andres Klode if (err > 0) {
3980cab4cb8SJulian Andres Klode list_del_init(&msg->node);
3990cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg);
4000cab4cb8SJulian Andres Klode }
4010cab4cb8SJulian Andres Klode }
4020cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags);
40332890b98SMarc Dietrich }
40432890b98SMarc Dietrich
405bdf034d9SJulian Andres Klode /**
406bdf034d9SJulian Andres Klode * parse_msg - Print some information and call the notifiers on an RX message
407bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
408bdf034d9SJulian Andres Klode * @msg: A message received by @nvec
409bdf034d9SJulian Andres Klode *
410bdf034d9SJulian Andres Klode * Paarse some pieces of the message and then call the chain of notifiers
411bdf034d9SJulian Andres Klode * registered via nvec_register_notifier.
412bdf034d9SJulian Andres Klode */
parse_msg(struct nvec_chip * nvec,struct nvec_msg * msg)41332890b98SMarc Dietrich static int parse_msg(struct nvec_chip *nvec, struct nvec_msg *msg)
41432890b98SMarc Dietrich {
41532890b98SMarc Dietrich if ((msg->data[0] & 1 << 7) == 0 && msg->data[3]) {
4166a371978SAndy Shevchenko dev_err(nvec->dev, "ec responded %*ph\n", 4, msg->data);
41732890b98SMarc Dietrich return -EINVAL;
41832890b98SMarc Dietrich }
41932890b98SMarc Dietrich
420a3a9aa1aSMarc Dietrich if ((msg->data[0] >> 7) == 1 && (msg->data[0] & 0x0f) == 5)
421a3a9aa1aSMarc Dietrich print_hex_dump(KERN_WARNING, "ec system event ",
422a3a9aa1aSMarc Dietrich DUMP_PREFIX_NONE, 16, 1, msg->data,
423a3a9aa1aSMarc Dietrich msg->data[1] + 2, true);
42432890b98SMarc Dietrich
425162c7d8cSMarc Dietrich atomic_notifier_call_chain(&nvec->notifier_list, msg->data[0] & 0x8f,
426162c7d8cSMarc Dietrich msg->data);
42732890b98SMarc Dietrich
42832890b98SMarc Dietrich return 0;
42932890b98SMarc Dietrich }
43032890b98SMarc Dietrich
431bdf034d9SJulian Andres Klode /**
432bdf034d9SJulian Andres Klode * nvec_dispatch - Process messages received from the EC
433bdf034d9SJulian Andres Klode * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip)
434bdf034d9SJulian Andres Klode *
435bdf034d9SJulian Andres Klode * Process messages previously received from the EC and put into the RX
436bdf034d9SJulian Andres Klode * queue of the &struct nvec_chip instance associated with @work.
437bdf034d9SJulian Andres Klode */
nvec_dispatch(struct work_struct * work)43832890b98SMarc Dietrich static void nvec_dispatch(struct work_struct *work)
43932890b98SMarc Dietrich {
44032890b98SMarc Dietrich struct nvec_chip *nvec = container_of(work, struct nvec_chip, rx_work);
4410cab4cb8SJulian Andres Klode unsigned long flags;
44232890b98SMarc Dietrich struct nvec_msg *msg;
44332890b98SMarc Dietrich
4440cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->rx_lock, flags);
445162c7d8cSMarc Dietrich while (!list_empty(&nvec->rx_data)) {
44632890b98SMarc Dietrich msg = list_first_entry(&nvec->rx_data, struct nvec_msg, node);
44732890b98SMarc Dietrich list_del_init(&msg->node);
4480cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->rx_lock, flags);
44932890b98SMarc Dietrich
450162c7d8cSMarc Dietrich if (nvec->sync_write_pending ==
451162c7d8cSMarc Dietrich (msg->data[2] << 8) + msg->data[0]) {
45232890b98SMarc Dietrich dev_dbg(nvec->dev, "sync write completed!\n");
45332890b98SMarc Dietrich nvec->sync_write_pending = 0;
45432890b98SMarc Dietrich nvec->last_sync_msg = msg;
45532890b98SMarc Dietrich complete(&nvec->sync_write);
45632890b98SMarc Dietrich } else {
45732890b98SMarc Dietrich parse_msg(nvec, msg);
4580cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg);
45932890b98SMarc Dietrich }
4600cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->rx_lock, flags);
46132890b98SMarc Dietrich }
4620cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->rx_lock, flags);
4630cab4cb8SJulian Andres Klode }
4640cab4cb8SJulian Andres Klode
465bdf034d9SJulian Andres Klode /**
466bdf034d9SJulian Andres Klode * nvec_tx_completed - Complete the current transfer
467bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
468bdf034d9SJulian Andres Klode *
469bdf034d9SJulian Andres Klode * This is called when we have received an END_TRANS on a TX transfer.
470bdf034d9SJulian Andres Klode */
nvec_tx_completed(struct nvec_chip * nvec)4710cab4cb8SJulian Andres Klode static void nvec_tx_completed(struct nvec_chip *nvec)
4720cab4cb8SJulian Andres Klode {
4730cab4cb8SJulian Andres Klode /* We got an END_TRANS, let's skip this, maybe there's an event */
4740cab4cb8SJulian Andres Klode if (nvec->tx->pos != nvec->tx->size) {
4750cab4cb8SJulian Andres Klode dev_err(nvec->dev, "premature END_TRANS, resending\n");
4760cab4cb8SJulian Andres Klode nvec->tx->pos = 0;
4770cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 0);
4780cab4cb8SJulian Andres Klode } else {
4790cab4cb8SJulian Andres Klode nvec->state = 0;
48032890b98SMarc Dietrich }
48132890b98SMarc Dietrich }
48232890b98SMarc Dietrich
483bdf034d9SJulian Andres Klode /**
484bdf034d9SJulian Andres Klode * nvec_rx_completed - Complete the current transfer
485bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
486bdf034d9SJulian Andres Klode *
487bdf034d9SJulian Andres Klode * This is called when we have received an END_TRANS on a RX transfer.
488bdf034d9SJulian Andres Klode */
nvec_rx_completed(struct nvec_chip * nvec)4890cab4cb8SJulian Andres Klode static void nvec_rx_completed(struct nvec_chip *nvec)
4900cab4cb8SJulian Andres Klode {
491210ceb4fSJulian Andres Klode if (nvec->rx->pos != nvec_msg_size(nvec->rx)) {
4920cab4cb8SJulian Andres Klode dev_err(nvec->dev, "RX incomplete: Expected %u bytes, got %u\n",
4930cab4cb8SJulian Andres Klode (uint)nvec_msg_size(nvec->rx),
4940cab4cb8SJulian Andres Klode (uint)nvec->rx->pos);
4950cab4cb8SJulian Andres Klode
496210ceb4fSJulian Andres Klode nvec_msg_free(nvec, nvec->rx);
497210ceb4fSJulian Andres Klode nvec->state = 0;
498d6bdcf2eSJulian Andres Klode
499d6bdcf2eSJulian Andres Klode /* Battery quirk - Often incomplete, and likes to crash */
500d6bdcf2eSJulian Andres Klode if (nvec->rx->data[0] == NVEC_BAT)
501d6bdcf2eSJulian Andres Klode complete(&nvec->ec_transfer);
502d6bdcf2eSJulian Andres Klode
503210ceb4fSJulian Andres Klode return;
504210ceb4fSJulian Andres Klode }
505210ceb4fSJulian Andres Klode
5060cab4cb8SJulian Andres Klode spin_lock(&nvec->rx_lock);
5070cab4cb8SJulian Andres Klode
50866ad85d1SSimon Guinot /*
50966ad85d1SSimon Guinot * Add the received data to the work list and move the ring buffer
51066ad85d1SSimon Guinot * pointer to the next entry.
51166ad85d1SSimon Guinot */
5120cab4cb8SJulian Andres Klode list_add_tail(&nvec->rx->node, &nvec->rx_data);
5130cab4cb8SJulian Andres Klode
5140cab4cb8SJulian Andres Klode spin_unlock(&nvec->rx_lock);
5150cab4cb8SJulian Andres Klode
5160cab4cb8SJulian Andres Klode nvec->state = 0;
5170cab4cb8SJulian Andres Klode
5180cab4cb8SJulian Andres Klode if (!nvec_msg_is_event(nvec->rx))
5190cab4cb8SJulian Andres Klode complete(&nvec->ec_transfer);
5200cab4cb8SJulian Andres Klode
521033d9959SLinus Torvalds schedule_work(&nvec->rx_work);
5220cab4cb8SJulian Andres Klode }
5230cab4cb8SJulian Andres Klode
5240cab4cb8SJulian Andres Klode /**
5250cab4cb8SJulian Andres Klode * nvec_invalid_flags - Send an error message about invalid flags and jump
5260cab4cb8SJulian Andres Klode * @nvec: The nvec device
5270cab4cb8SJulian Andres Klode * @status: The status flags
5280cab4cb8SJulian Andres Klode * @reset: Whether we shall jump to state 0.
5290cab4cb8SJulian Andres Klode */
nvec_invalid_flags(struct nvec_chip * nvec,unsigned int status,bool reset)5300cab4cb8SJulian Andres Klode static void nvec_invalid_flags(struct nvec_chip *nvec, unsigned int status,
5310cab4cb8SJulian Andres Klode bool reset)
5320cab4cb8SJulian Andres Klode {
5330cab4cb8SJulian Andres Klode dev_err(nvec->dev, "unexpected status flags 0x%02x during state %i\n",
5340cab4cb8SJulian Andres Klode status, nvec->state);
5350cab4cb8SJulian Andres Klode if (reset)
5360cab4cb8SJulian Andres Klode nvec->state = 0;
5370cab4cb8SJulian Andres Klode }
5380cab4cb8SJulian Andres Klode
5390cab4cb8SJulian Andres Klode /**
5400cab4cb8SJulian Andres Klode * nvec_tx_set - Set the message to transfer (nvec->tx)
541bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip
542bdf034d9SJulian Andres Klode *
543bdf034d9SJulian Andres Klode * Gets the first entry from the tx_data list of @nvec and sets the
544bdf034d9SJulian Andres Klode * tx member to it. If the tx_data list is empty, this uses the
545bdf034d9SJulian Andres Klode * tx_scratch message to send a no operation message.
5460cab4cb8SJulian Andres Klode */
nvec_tx_set(struct nvec_chip * nvec)5470cab4cb8SJulian Andres Klode static void nvec_tx_set(struct nvec_chip *nvec)
5480cab4cb8SJulian Andres Klode {
5490cab4cb8SJulian Andres Klode spin_lock(&nvec->tx_lock);
5500cab4cb8SJulian Andres Klode if (list_empty(&nvec->tx_data)) {
5510cab4cb8SJulian Andres Klode dev_err(nvec->dev, "empty tx - sending no-op\n");
5520cab4cb8SJulian Andres Klode memcpy(nvec->tx_scratch.data, "\x02\x07\x02", 3);
5530cab4cb8SJulian Andres Klode nvec->tx_scratch.size = 3;
5540cab4cb8SJulian Andres Klode nvec->tx_scratch.pos = 0;
5550cab4cb8SJulian Andres Klode nvec->tx = &nvec->tx_scratch;
5560cab4cb8SJulian Andres Klode list_add_tail(&nvec->tx->node, &nvec->tx_data);
5570cab4cb8SJulian Andres Klode } else {
5580cab4cb8SJulian Andres Klode nvec->tx = list_first_entry(&nvec->tx_data, struct nvec_msg,
5590cab4cb8SJulian Andres Klode node);
5600cab4cb8SJulian Andres Klode nvec->tx->pos = 0;
5610cab4cb8SJulian Andres Klode }
5620cab4cb8SJulian Andres Klode spin_unlock(&nvec->tx_lock);
5630cab4cb8SJulian Andres Klode
5640cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "Sending message of length %u, command 0x%x\n",
5650cab4cb8SJulian Andres Klode (uint)nvec->tx->size, nvec->tx->data[1]);
5660cab4cb8SJulian Andres Klode }
5670cab4cb8SJulian Andres Klode
5680cab4cb8SJulian Andres Klode /**
5690cab4cb8SJulian Andres Klode * nvec_interrupt - Interrupt handler
5700cab4cb8SJulian Andres Klode * @irq: The IRQ
5710cab4cb8SJulian Andres Klode * @dev: The nvec device
572bdf034d9SJulian Andres Klode *
573bdf034d9SJulian Andres Klode * Interrupt handler that fills our RX buffers and empties our TX
574bdf034d9SJulian Andres Klode * buffers. This uses a finite state machine with ridiculous amounts
575bdf034d9SJulian Andres Klode * of error checking, in order to be fairly reliable.
5760cab4cb8SJulian Andres Klode */
nvec_interrupt(int irq,void * dev)577f686e9afSMarc Dietrich static irqreturn_t nvec_interrupt(int irq, void *dev)
57832890b98SMarc Dietrich {
57932890b98SMarc Dietrich unsigned long status;
5800cab4cb8SJulian Andres Klode unsigned int received = 0;
5810cab4cb8SJulian Andres Klode unsigned char to_send = 0xff;
5820cab4cb8SJulian Andres Klode const unsigned long irq_mask = I2C_SL_IRQ | END_TRANS | RCVD | RNW;
5830cab4cb8SJulian Andres Klode struct nvec_chip *nvec = dev;
5840cab4cb8SJulian Andres Klode unsigned int state = nvec->state;
58532890b98SMarc Dietrich
5860cab4cb8SJulian Andres Klode status = readl(nvec->base + I2C_SL_STATUS);
58732890b98SMarc Dietrich
5880cab4cb8SJulian Andres Klode /* Filter out some errors */
5890cab4cb8SJulian Andres Klode if ((status & irq_mask) == 0 && (status & ~irq_mask) != 0) {
5900cab4cb8SJulian Andres Klode dev_err(nvec->dev, "unexpected irq mask %lx\n", status);
59132890b98SMarc Dietrich return IRQ_HANDLED;
5920cab4cb8SJulian Andres Klode }
5930cab4cb8SJulian Andres Klode if ((status & I2C_SL_IRQ) == 0) {
5940cab4cb8SJulian Andres Klode dev_err(nvec->dev, "Spurious IRQ\n");
5950cab4cb8SJulian Andres Klode return IRQ_HANDLED;
5960cab4cb8SJulian Andres Klode }
5970cab4cb8SJulian Andres Klode
5980cab4cb8SJulian Andres Klode /* The EC did not request a read, so it send us something, read it */
5990cab4cb8SJulian Andres Klode if ((status & RNW) == 0) {
6000cab4cb8SJulian Andres Klode received = readl(nvec->base + I2C_SL_RCVD);
60132890b98SMarc Dietrich if (status & RCVD)
6020cab4cb8SJulian Andres Klode writel(0, nvec->base + I2C_SL_RCVD);
6030cab4cb8SJulian Andres Klode }
60432890b98SMarc Dietrich
6050cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RCVD))
6060cab4cb8SJulian Andres Klode nvec->state = 0;
607162c7d8cSMarc Dietrich
6080cab4cb8SJulian Andres Klode switch (nvec->state) {
6090cab4cb8SJulian Andres Klode case 0: /* Verify that its a transfer start, the rest later */
6100cab4cb8SJulian Andres Klode if (status != (I2C_SL_IRQ | RCVD))
6110cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, false);
6120cab4cb8SJulian Andres Klode break;
6130cab4cb8SJulian Andres Klode case 1: /* command byte */
6140cab4cb8SJulian Andres Klode if (status != I2C_SL_IRQ) {
6150cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true);
61632890b98SMarc Dietrich } else {
617bb0590e2SJulian Andres Klode nvec->rx = nvec_msg_alloc(nvec, NVEC_MSG_RX);
6188da79863SJulian Andres Klode /* Should not happen in a normal world */
619f05f33faSLaura Garcia Liebana if (unlikely(!nvec->rx)) {
6208da79863SJulian Andres Klode nvec->state = 0;
6218da79863SJulian Andres Klode break;
6228da79863SJulian Andres Klode }
6230cab4cb8SJulian Andres Klode nvec->rx->data[0] = received;
6240cab4cb8SJulian Andres Klode nvec->rx->pos = 1;
6250cab4cb8SJulian Andres Klode nvec->state = 2;
6260cab4cb8SJulian Andres Klode }
6270cab4cb8SJulian Andres Klode break;
6280cab4cb8SJulian Andres Klode case 2: /* first byte after command */
6290cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RNW | RCVD)) {
6300cab4cb8SJulian Andres Klode udelay(33);
6310cab4cb8SJulian Andres Klode if (nvec->rx->data[0] != 0x01) {
6320cab4cb8SJulian Andres Klode dev_err(nvec->dev,
6330cab4cb8SJulian Andres Klode "Read without prior read command\n");
6340cab4cb8SJulian Andres Klode nvec->state = 0;
6350cab4cb8SJulian Andres Klode break;
6360cab4cb8SJulian Andres Klode }
6370cab4cb8SJulian Andres Klode nvec_msg_free(nvec, nvec->rx);
6380cab4cb8SJulian Andres Klode nvec->state = 3;
6390cab4cb8SJulian Andres Klode nvec_tx_set(nvec);
6400cab4cb8SJulian Andres Klode to_send = nvec->tx->data[0];
6410cab4cb8SJulian Andres Klode nvec->tx->pos = 1;
6420cab4cb8SJulian Andres Klode } else if (status == (I2C_SL_IRQ)) {
6430cab4cb8SJulian Andres Klode nvec->rx->data[1] = received;
6440cab4cb8SJulian Andres Klode nvec->rx->pos = 2;
6450cab4cb8SJulian Andres Klode nvec->state = 4;
64632890b98SMarc Dietrich } else {
6470cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true);
64832890b98SMarc Dietrich }
6490cab4cb8SJulian Andres Klode break;
6500cab4cb8SJulian Andres Klode case 3: /* EC does a block read, we transmit data */
6510cab4cb8SJulian Andres Klode if (status & END_TRANS) {
6520cab4cb8SJulian Andres Klode nvec_tx_completed(nvec);
6530cab4cb8SJulian Andres Klode } else if ((status & RNW) == 0 || (status & RCVD)) {
6540cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true);
6550cab4cb8SJulian Andres Klode } else if (nvec->tx && nvec->tx->pos < nvec->tx->size) {
6560cab4cb8SJulian Andres Klode to_send = nvec->tx->data[nvec->tx->pos++];
65732890b98SMarc Dietrich } else {
6589fc27699SLaura Garcia Liebana dev_err(nvec->dev,
6599fc27699SLaura Garcia Liebana "tx buffer underflow on %p (%u > %u)\n",
6600cab4cb8SJulian Andres Klode nvec->tx,
6610cab4cb8SJulian Andres Klode (uint)(nvec->tx ? nvec->tx->pos : 0),
6620cab4cb8SJulian Andres Klode (uint)(nvec->tx ? nvec->tx->size : 0));
6630cab4cb8SJulian Andres Klode nvec->state = 0;
6640cab4cb8SJulian Andres Klode }
6650cab4cb8SJulian Andres Klode break;
6660cab4cb8SJulian Andres Klode case 4: /* EC does some write, we read the data */
6670cab4cb8SJulian Andres Klode if ((status & (END_TRANS | RNW)) == END_TRANS)
6680cab4cb8SJulian Andres Klode nvec_rx_completed(nvec);
6690cab4cb8SJulian Andres Klode else if (status & (RNW | RCVD))
6700cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true);
6710cab4cb8SJulian Andres Klode else if (nvec->rx && nvec->rx->pos < NVEC_MSG_SIZE)
6720cab4cb8SJulian Andres Klode nvec->rx->data[nvec->rx->pos++] = received;
6730cab4cb8SJulian Andres Klode else
6740cab4cb8SJulian Andres Klode dev_err(nvec->dev,
675b77f2767SEbru Akagunduz "RX buffer overflow on %p: Trying to write byte %u of %u\n",
6766330f9cfSDan Carpenter nvec->rx, nvec->rx ? nvec->rx->pos : 0,
6776330f9cfSDan Carpenter NVEC_MSG_SIZE);
6780cab4cb8SJulian Andres Klode break;
6790cab4cb8SJulian Andres Klode default:
6800cab4cb8SJulian Andres Klode nvec->state = 0;
68132890b98SMarc Dietrich }
68232890b98SMarc Dietrich
6830cab4cb8SJulian Andres Klode /* If we are told that a new transfer starts, verify it */
6840cab4cb8SJulian Andres Klode if ((status & (RCVD | RNW)) == RCVD) {
6850cab4cb8SJulian Andres Klode if (received != nvec->i2c_addr)
6860cab4cb8SJulian Andres Klode dev_err(nvec->dev,
6870cab4cb8SJulian Andres Klode "received address 0x%02x, expected 0x%02x\n",
6880cab4cb8SJulian Andres Klode received, nvec->i2c_addr);
6890cab4cb8SJulian Andres Klode nvec->state = 1;
69032890b98SMarc Dietrich }
6910cab4cb8SJulian Andres Klode
6920cab4cb8SJulian Andres Klode /* Send data if requested, but not on end of transmission */
6930cab4cb8SJulian Andres Klode if ((status & (RNW | END_TRANS)) == RNW)
6940cab4cb8SJulian Andres Klode writel(to_send, nvec->base + I2C_SL_RCVD);
6950cab4cb8SJulian Andres Klode
6960cab4cb8SJulian Andres Klode /* If we have send the first byte */
6970cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RNW | RCVD))
6980cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 1);
6990cab4cb8SJulian Andres Klode
7000cab4cb8SJulian Andres Klode dev_dbg(nvec->dev,
7010cab4cb8SJulian Andres Klode "Handled: %s 0x%02x, %s 0x%02x in state %u [%s%s%s]\n",
7020cab4cb8SJulian Andres Klode (status & RNW) == 0 ? "received" : "R=",
7030cab4cb8SJulian Andres Klode received,
7040cab4cb8SJulian Andres Klode (status & (RNW | END_TRANS)) ? "sent" : "S=",
7050cab4cb8SJulian Andres Klode to_send,
7060cab4cb8SJulian Andres Klode state,
7070cab4cb8SJulian Andres Klode status & END_TRANS ? " END_TRANS" : "",
7080cab4cb8SJulian Andres Klode status & RCVD ? " RCVD" : "",
7090cab4cb8SJulian Andres Klode status & RNW ? " RNW" : "");
7100cab4cb8SJulian Andres Klode
711de839b8fSJulian Andres Klode /*
712de839b8fSJulian Andres Klode * TODO: A correct fix needs to be found for this.
713de839b8fSJulian Andres Klode *
714de839b8fSJulian Andres Klode * We experience less incomplete messages with this delay than without
715de839b8fSJulian Andres Klode * it, but we don't know why. Help is appreciated.
716de839b8fSJulian Andres Klode */
717de839b8fSJulian Andres Klode udelay(100);
718de839b8fSJulian Andres Klode
71932890b98SMarc Dietrich return IRQ_HANDLED;
72032890b98SMarc Dietrich }
72132890b98SMarc Dietrich
tegra_init_i2c_slave(struct nvec_chip * nvec)722f686e9afSMarc Dietrich static void tegra_init_i2c_slave(struct nvec_chip *nvec)
72332890b98SMarc Dietrich {
72432890b98SMarc Dietrich u32 val;
72532890b98SMarc Dietrich
72661c3b197SPrashant Gaikwad clk_prepare_enable(nvec->i2c_clk);
727f686e9afSMarc Dietrich
728c0df5bf5SStephen Warren reset_control_assert(nvec->rst);
72932890b98SMarc Dietrich udelay(2);
730c0df5bf5SStephen Warren reset_control_deassert(nvec->rst);
73132890b98SMarc Dietrich
73232890b98SMarc Dietrich val = I2C_CNFG_NEW_MASTER_SFM | I2C_CNFG_PACKET_MODE_EN |
73332890b98SMarc Dietrich (0x2 << I2C_CNFG_DEBOUNCE_CNT_SHIFT);
734f686e9afSMarc Dietrich writel(val, nvec->base + I2C_CNFG);
73532890b98SMarc Dietrich
736ac810759SMarc Dietrich clk_set_rate(nvec->i2c_clk, 8 * 80000);
737ac810759SMarc Dietrich
738d3f862aeSJulian Andres Klode writel(I2C_SL_NEWSL, nvec->base + I2C_SL_CNFG);
739ac810759SMarc Dietrich writel(0x1E, nvec->base + I2C_SL_DELAY_COUNT);
740ac810759SMarc Dietrich
741ac810759SMarc Dietrich writel(nvec->i2c_addr >> 1, nvec->base + I2C_SL_ADDR1);
742ac810759SMarc Dietrich writel(0, nvec->base + I2C_SL_ADDR2);
743ac810759SMarc Dietrich
744ac810759SMarc Dietrich enable_irq(nvec->irq);
745ac810759SMarc Dietrich }
746ac810759SMarc Dietrich
747ebefae28SMarc Dietrich #ifdef CONFIG_PM_SLEEP
nvec_disable_i2c_slave(struct nvec_chip * nvec)748ac810759SMarc Dietrich static void nvec_disable_i2c_slave(struct nvec_chip *nvec)
749ac810759SMarc Dietrich {
750ac810759SMarc Dietrich disable_irq(nvec->irq);
751d3f862aeSJulian Andres Klode writel(I2C_SL_NEWSL | I2C_SL_NACK, nvec->base + I2C_SL_CNFG);
75261c3b197SPrashant Gaikwad clk_disable_unprepare(nvec->i2c_clk);
75332890b98SMarc Dietrich }
754ebefae28SMarc Dietrich #endif
75532890b98SMarc Dietrich
nvec_power_off(void)75632890b98SMarc Dietrich static void nvec_power_off(void)
75732890b98SMarc Dietrich {
75893eff83fSMarc Dietrich char ap_pwr_down[] = { NVEC_SLEEP, AP_PWR_DOWN };
75993eff83fSMarc Dietrich
760518945fbSMarc Dietrich nvec_toggle_global_events(nvec_power_handle, false);
76193eff83fSMarc Dietrich nvec_write_async(nvec_power_handle, ap_pwr_down, 2);
76232890b98SMarc Dietrich }
76332890b98SMarc Dietrich
tegra_nvec_probe(struct platform_device * pdev)76446620803SBill Pemberton static int tegra_nvec_probe(struct platform_device *pdev)
76532890b98SMarc Dietrich {
766f686e9afSMarc Dietrich int err, ret;
76732890b98SMarc Dietrich struct clk *i2c_clk;
768d4381795SMarc Dietrich struct device *dev = &pdev->dev;
76932890b98SMarc Dietrich struct nvec_chip *nvec;
77032890b98SMarc Dietrich struct nvec_msg *msg;
771f686e9afSMarc Dietrich void __iomem *base;
77293eff83fSMarc Dietrich char get_firmware_version[] = { NVEC_CNTL, GET_FIRMWARE_VERSION },
77393eff83fSMarc Dietrich unmute_speakers[] = { NVEC_OEM0, 0x10, 0x59, 0x95 },
77493eff83fSMarc Dietrich enable_event[7] = { NVEC_SYS, CNF_EVENT_REPORTING, true };
77532890b98SMarc Dietrich
776d4381795SMarc Dietrich if (!dev->of_node) {
777d4381795SMarc Dietrich dev_err(dev, "must be instantiated using device tree\n");
7782c6cbdd0SMarc Dietrich return -ENODEV;
7792c6cbdd0SMarc Dietrich }
7802c6cbdd0SMarc Dietrich
781d4381795SMarc Dietrich nvec = devm_kzalloc(dev, sizeof(struct nvec_chip), GFP_KERNEL);
7824c42d979SSomya Anand if (!nvec)
78332890b98SMarc Dietrich return -ENOMEM;
7845a9077a8SPawel Lebioda
78532890b98SMarc Dietrich platform_set_drvdata(pdev, nvec);
786d4381795SMarc Dietrich nvec->dev = dev;
7877990b0d7SMarc Dietrich
78840fbffd9SMarc Dietrich if (of_property_read_u32(dev->of_node, "slave-addr", &nvec->i2c_addr)) {
78940fbffd9SMarc Dietrich dev_err(dev, "no i2c address specified");
79040fbffd9SMarc Dietrich return -ENODEV;
79140fbffd9SMarc Dietrich }
79232890b98SMarc Dietrich
79377b0a841SHariprasad Kelam base = devm_platform_ioremap_resource(pdev, 0);
79497f4be60SThierry Reding if (IS_ERR(base))
79597f4be60SThierry Reding return PTR_ERR(base);
79632890b98SMarc Dietrich
797b5b628baSThierry Reding nvec->irq = platform_get_irq(pdev, 0);
79804d15d5cSStephen Boyd if (nvec->irq < 0)
799f5e3352eSMarc Dietrich return -ENODEV;
800f686e9afSMarc Dietrich
801d4381795SMarc Dietrich i2c_clk = devm_clk_get(dev, "div-clk");
802f686e9afSMarc Dietrich if (IS_ERR(i2c_clk)) {
803d4381795SMarc Dietrich dev_err(dev, "failed to get controller clock\n");
804f5e3352eSMarc Dietrich return -ENODEV;
80532890b98SMarc Dietrich }
80632890b98SMarc Dietrich
807d4381795SMarc Dietrich nvec->rst = devm_reset_control_get_exclusive(dev, "i2c");
808c0df5bf5SStephen Warren if (IS_ERR(nvec->rst)) {
809d4381795SMarc Dietrich dev_err(dev, "failed to get controller reset\n");
810c0df5bf5SStephen Warren return PTR_ERR(nvec->rst);
811c0df5bf5SStephen Warren }
812c0df5bf5SStephen Warren
813f686e9afSMarc Dietrich nvec->base = base;
814f686e9afSMarc Dietrich nvec->i2c_clk = i2c_clk;
8150cab4cb8SJulian Andres Klode nvec->rx = &nvec->msg_pool[0];
816f686e9afSMarc Dietrich
81732890b98SMarc Dietrich ATOMIC_INIT_NOTIFIER_HEAD(&nvec->notifier_list);
81832890b98SMarc Dietrich
81932890b98SMarc Dietrich init_completion(&nvec->sync_write);
8200cab4cb8SJulian Andres Klode init_completion(&nvec->ec_transfer);
8210cab4cb8SJulian Andres Klode mutex_init(&nvec->sync_write_mutex);
8220cab4cb8SJulian Andres Klode spin_lock_init(&nvec->tx_lock);
8230cab4cb8SJulian Andres Klode spin_lock_init(&nvec->rx_lock);
82432890b98SMarc Dietrich INIT_LIST_HEAD(&nvec->rx_data);
8250cab4cb8SJulian Andres Klode INIT_LIST_HEAD(&nvec->tx_data);
82632890b98SMarc Dietrich INIT_WORK(&nvec->rx_work, nvec_dispatch);
82732890b98SMarc Dietrich INIT_WORK(&nvec->tx_work, nvec_request_master);
82832890b98SMarc Dietrich
82940fbffd9SMarc Dietrich nvec->gpiod = devm_gpiod_get(dev, "request", GPIOD_OUT_HIGH);
83040fbffd9SMarc Dietrich if (IS_ERR(nvec->gpiod)) {
831d4381795SMarc Dietrich dev_err(dev, "couldn't request gpio\n");
83240fbffd9SMarc Dietrich return PTR_ERR(nvec->gpiod);
833aed92bbcSJulian Andres Klode }
834aed92bbcSJulian Andres Klode
835d4381795SMarc Dietrich err = devm_request_irq(dev, nvec->irq, nvec_interrupt, 0,
836f5e3352eSMarc Dietrich "nvec", nvec);
837f686e9afSMarc Dietrich if (err) {
838d4381795SMarc Dietrich dev_err(dev, "couldn't request irq\n");
839f5e3352eSMarc Dietrich return -ENODEV;
840f686e9afSMarc Dietrich }
841ac810759SMarc Dietrich disable_irq(nvec->irq);
842f686e9afSMarc Dietrich
843f686e9afSMarc Dietrich tegra_init_i2c_slave(nvec);
844f686e9afSMarc Dietrich
84532890b98SMarc Dietrich /* enable event reporting */
846518945fbSMarc Dietrich nvec_toggle_global_events(nvec, true);
84732890b98SMarc Dietrich
84832890b98SMarc Dietrich nvec->nvec_status_notifier.notifier_call = nvec_status_notifier;
84932890b98SMarc Dietrich nvec_register_notifier(nvec, &nvec->nvec_status_notifier, 0);
85032890b98SMarc Dietrich
85132890b98SMarc Dietrich nvec_power_handle = nvec;
85232890b98SMarc Dietrich pm_power_off = nvec_power_off;
85332890b98SMarc Dietrich
85432890b98SMarc Dietrich /* Get Firmware Version */
85573b37c91STomás Tormo err = nvec_write_sync(nvec, get_firmware_version, 2, &msg);
85632890b98SMarc Dietrich
85773b37c91STomás Tormo if (!err) {
858d4381795SMarc Dietrich dev_warn(dev,
859a4fe05d5SLaura Garcia Liebana "ec firmware version %02x.%02x.%02x / %02x\n",
860a4fe05d5SLaura Garcia Liebana msg->data[4], msg->data[5],
861a4fe05d5SLaura Garcia Liebana msg->data[6], msg->data[7]);
86232890b98SMarc Dietrich
8630cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg);
8640cab4cb8SJulian Andres Klode }
86532890b98SMarc Dietrich
866d4381795SMarc Dietrich ret = mfd_add_devices(dev, 0, nvec_devices,
86747e7b050SThierry Reding ARRAY_SIZE(nvec_devices), NULL, 0, NULL);
868f686e9afSMarc Dietrich if (ret)
869d4381795SMarc Dietrich dev_err(dev, "error adding subdevices\n");
870f686e9afSMarc Dietrich
87132890b98SMarc Dietrich /* unmute speakers? */
87293eff83fSMarc Dietrich nvec_write_async(nvec, unmute_speakers, 4);
87332890b98SMarc Dietrich
87432890b98SMarc Dietrich /* enable lid switch event */
87593eff83fSMarc Dietrich nvec_event_mask(enable_event, LID_SWITCH);
87693eff83fSMarc Dietrich nvec_write_async(nvec, enable_event, 7);
87732890b98SMarc Dietrich
87832890b98SMarc Dietrich /* enable power button event */
87993eff83fSMarc Dietrich nvec_event_mask(enable_event, PWR_BUTTON);
88093eff83fSMarc Dietrich nvec_write_async(nvec, enable_event, 7);
88132890b98SMarc Dietrich
88232890b98SMarc Dietrich return 0;
88332890b98SMarc Dietrich }
88432890b98SMarc Dietrich
tegra_nvec_remove(struct platform_device * pdev)885*398296fdSUwe Kleine-König static void tegra_nvec_remove(struct platform_device *pdev)
88632890b98SMarc Dietrich {
887f686e9afSMarc Dietrich struct nvec_chip *nvec = platform_get_drvdata(pdev);
888f686e9afSMarc Dietrich
889518945fbSMarc Dietrich nvec_toggle_global_events(nvec, false);
890f686e9afSMarc Dietrich mfd_remove_devices(nvec->dev);
891c2b62f60SMarc Dietrich nvec_unregister_notifier(nvec, &nvec->nvec_status_notifier);
892eb1e40a4STejun Heo cancel_work_sync(&nvec->rx_work);
893eb1e40a4STejun Heo cancel_work_sync(&nvec->tx_work);
894fd90ae2cSShailendra Verma /* FIXME: needs check whether nvec is responsible for power off */
895c2b62f60SMarc Dietrich pm_power_off = NULL;
89632890b98SMarc Dietrich }
89732890b98SMarc Dietrich
898ebefae28SMarc Dietrich #ifdef CONFIG_PM_SLEEP
nvec_suspend(struct device * dev)899ebefae28SMarc Dietrich static int nvec_suspend(struct device *dev)
90032890b98SMarc Dietrich {
90173b37c91STomás Tormo int err;
9023c31e04bSWolfram Sang struct nvec_chip *nvec = dev_get_drvdata(dev);
9039feeb014SMarc Dietrich struct nvec_msg *msg;
90493eff83fSMarc Dietrich char ap_suspend[] = { NVEC_SLEEP, AP_SUSPEND };
90532890b98SMarc Dietrich
90632890b98SMarc Dietrich dev_dbg(nvec->dev, "suspending\n");
9079feeb014SMarc Dietrich
9089feeb014SMarc Dietrich /* keep these sync or you'll break suspend */
90993eff83fSMarc Dietrich nvec_toggle_global_events(nvec, false);
91093eff83fSMarc Dietrich
91173b37c91STomás Tormo err = nvec_write_sync(nvec, ap_suspend, sizeof(ap_suspend), &msg);
91273b37c91STomás Tormo if (!err)
9139feeb014SMarc Dietrich nvec_msg_free(nvec, msg);
9149feeb014SMarc Dietrich
915ac810759SMarc Dietrich nvec_disable_i2c_slave(nvec);
91632890b98SMarc Dietrich
91732890b98SMarc Dietrich return 0;
91832890b98SMarc Dietrich }
91932890b98SMarc Dietrich
nvec_resume(struct device * dev)920ebefae28SMarc Dietrich static int nvec_resume(struct device *dev)
921162c7d8cSMarc Dietrich {
9223c31e04bSWolfram Sang struct nvec_chip *nvec = dev_get_drvdata(dev);
92332890b98SMarc Dietrich
92432890b98SMarc Dietrich dev_dbg(nvec->dev, "resuming\n");
925f686e9afSMarc Dietrich tegra_init_i2c_slave(nvec);
926518945fbSMarc Dietrich nvec_toggle_global_events(nvec, true);
92732890b98SMarc Dietrich
92832890b98SMarc Dietrich return 0;
92932890b98SMarc Dietrich }
93032890b98SMarc Dietrich #endif
93132890b98SMarc Dietrich
9325d30566fSThierry Reding static SIMPLE_DEV_PM_OPS(nvec_pm_ops, nvec_suspend, nvec_resume);
933ebefae28SMarc Dietrich
9347990b0d7SMarc Dietrich /* Match table for of_platform binding */
935063f9f6aSBill Pemberton static const struct of_device_id nvidia_nvec_of_match[] = {
9367990b0d7SMarc Dietrich { .compatible = "nvidia,nvec", },
9377990b0d7SMarc Dietrich {},
9387990b0d7SMarc Dietrich };
9397990b0d7SMarc Dietrich MODULE_DEVICE_TABLE(of, nvidia_nvec_of_match);
9407990b0d7SMarc Dietrich
941162c7d8cSMarc Dietrich static struct platform_driver nvec_device_driver = {
94232890b98SMarc Dietrich .probe = tegra_nvec_probe,
943*398296fdSUwe Kleine-König .remove_new = tegra_nvec_remove,
94432890b98SMarc Dietrich .driver = {
94532890b98SMarc Dietrich .name = "nvec",
946ebefae28SMarc Dietrich .pm = &nvec_pm_ops,
9477990b0d7SMarc Dietrich .of_match_table = nvidia_nvec_of_match,
94832890b98SMarc Dietrich }
94932890b98SMarc Dietrich };
95032890b98SMarc Dietrich
9519891b1ceSMarc Dietrich module_platform_driver(nvec_device_driver);
952162c7d8cSMarc Dietrich
95332890b98SMarc Dietrich MODULE_ALIAS("platform:nvec");
954162c7d8cSMarc Dietrich MODULE_DESCRIPTION("NVIDIA compliant embedded controller interface");
955162c7d8cSMarc Dietrich MODULE_AUTHOR("Marc Dietrich <marvin24@gmx.de>");
956162c7d8cSMarc Dietrich MODULE_LICENSE("GPL");
957