1162c7d8cSMarc Dietrich /* 2162c7d8cSMarc Dietrich * NVEC: NVIDIA compliant embedded controller interface 3162c7d8cSMarc Dietrich * 4162c7d8cSMarc Dietrich * Copyright (C) 2011 The AC100 Kernel Team <ac100@lists.lauchpad.net> 5162c7d8cSMarc Dietrich * 6162c7d8cSMarc Dietrich * Authors: Pierre-Hugues Husson <phhusson@free.fr> 7162c7d8cSMarc Dietrich * Ilya Petrov <ilya.muromec@gmail.com> 8162c7d8cSMarc Dietrich * Marc Dietrich <marvin24@gmx.de> 9791c4a64SJulian Andres Klode * Julian Andres Klode <jak@jak-linux.org> 10162c7d8cSMarc Dietrich * 11162c7d8cSMarc Dietrich * This file is subject to the terms and conditions of the GNU General Public 12162c7d8cSMarc Dietrich * License. See the file "COPYING" in the main directory of this archive 13162c7d8cSMarc Dietrich * for more details. 14162c7d8cSMarc Dietrich * 1532890b98SMarc Dietrich */ 1632890b98SMarc Dietrich 17162c7d8cSMarc Dietrich /* #define DEBUG */ 18162c7d8cSMarc Dietrich 1912b5a55dSJulian Andres Klode #include <linux/kernel.h> 203b769eddSMarc Dietrich #include <linux/module.h> 210b1076c4SJulian Andres Klode #include <linux/atomic.h> 2212b5a55dSJulian Andres Klode #include <linux/clk.h> 2332890b98SMarc Dietrich #include <linux/completion.h> 2412b5a55dSJulian Andres Klode #include <linux/delay.h> 2512b5a55dSJulian Andres Klode #include <linux/err.h> 2612b5a55dSJulian Andres Klode #include <linux/gpio.h> 2732890b98SMarc Dietrich #include <linux/interrupt.h> 28162c7d8cSMarc Dietrich #include <linux/io.h> 2932890b98SMarc Dietrich #include <linux/irq.h> 307990b0d7SMarc Dietrich #include <linux/of.h> 317990b0d7SMarc Dietrich #include <linux/of_gpio.h> 3232890b98SMarc Dietrich #include <linux/list.h> 3312b5a55dSJulian Andres Klode #include <linux/mfd/core.h> 3412b5a55dSJulian Andres Klode #include <linux/mutex.h> 3532890b98SMarc Dietrich #include <linux/notifier.h> 3612b5a55dSJulian Andres Klode #include <linux/slab.h> 3712b5a55dSJulian Andres Klode #include <linux/spinlock.h> 3812b5a55dSJulian Andres Klode #include <linux/workqueue.h> 39162c7d8cSMarc Dietrich 4032890b98SMarc Dietrich #include "nvec.h" 4132890b98SMarc Dietrich 42391d2fa9SJulian Andres Klode #define I2C_CNFG 0x00 43391d2fa9SJulian Andres Klode #define I2C_CNFG_PACKET_MODE_EN (1<<10) 44391d2fa9SJulian Andres Klode #define I2C_CNFG_NEW_MASTER_SFM (1<<11) 45391d2fa9SJulian Andres Klode #define I2C_CNFG_DEBOUNCE_CNT_SHIFT 12 46391d2fa9SJulian Andres Klode 47391d2fa9SJulian Andres Klode #define I2C_SL_CNFG 0x20 48d3f862aeSJulian Andres Klode #define I2C_SL_NEWSL (1<<2) 49391d2fa9SJulian Andres Klode #define I2C_SL_NACK (1<<1) 50391d2fa9SJulian Andres Klode #define I2C_SL_RESP (1<<0) 51391d2fa9SJulian Andres Klode #define I2C_SL_IRQ (1<<3) 52391d2fa9SJulian Andres Klode #define END_TRANS (1<<4) 53391d2fa9SJulian Andres Klode #define RCVD (1<<2) 54391d2fa9SJulian Andres Klode #define RNW (1<<1) 55391d2fa9SJulian Andres Klode 56391d2fa9SJulian Andres Klode #define I2C_SL_RCVD 0x24 57391d2fa9SJulian Andres Klode #define I2C_SL_STATUS 0x28 58391d2fa9SJulian Andres Klode #define I2C_SL_ADDR1 0x2c 59391d2fa9SJulian Andres Klode #define I2C_SL_ADDR2 0x30 60391d2fa9SJulian Andres Klode #define I2C_SL_DELAY_COUNT 0x3c 61391d2fa9SJulian Andres Klode 62bb0590e2SJulian Andres Klode /** 63bb0590e2SJulian Andres Klode * enum nvec_msg_category - Message categories for nvec_msg_alloc() 64bb0590e2SJulian Andres Klode * @NVEC_MSG_RX: The message is an incoming message (from EC) 65bb0590e2SJulian Andres Klode * @NVEC_MSG_TX: The message is an outgoing message (to EC) 66bb0590e2SJulian Andres Klode */ 67bb0590e2SJulian Andres Klode enum nvec_msg_category { 68bb0590e2SJulian Andres Klode NVEC_MSG_RX, 69bb0590e2SJulian Andres Klode NVEC_MSG_TX, 70bb0590e2SJulian Andres Klode }; 71bb0590e2SJulian Andres Klode 72518945fbSMarc Dietrich enum nvec_sleep_subcmds { 73518945fbSMarc Dietrich GLOBAL_EVENTS, 7493eff83fSMarc Dietrich AP_PWR_DOWN, 7593eff83fSMarc Dietrich AP_SUSPEND, 76518945fbSMarc Dietrich }; 77518945fbSMarc Dietrich 7893eff83fSMarc Dietrich #define CNF_EVENT_REPORTING 0x01 7993eff83fSMarc Dietrich #define GET_FIRMWARE_VERSION 0x15 8093eff83fSMarc Dietrich #define LID_SWITCH BIT(1) 8193eff83fSMarc Dietrich #define PWR_BUTTON BIT(15) 8232890b98SMarc Dietrich 8332890b98SMarc Dietrich static struct nvec_chip *nvec_power_handle; 8432890b98SMarc Dietrich 8528397dc9SGeert Uytterhoeven static const struct mfd_cell nvec_devices[] = { 86f686e9afSMarc Dietrich { 87f686e9afSMarc Dietrich .name = "nvec-kbd", 88f686e9afSMarc Dietrich .id = 1, 89f686e9afSMarc Dietrich }, 90f686e9afSMarc Dietrich { 91f686e9afSMarc Dietrich .name = "nvec-mouse", 92f686e9afSMarc Dietrich .id = 1, 93f686e9afSMarc Dietrich }, 94f686e9afSMarc Dietrich { 95f686e9afSMarc Dietrich .name = "nvec-power", 96f686e9afSMarc Dietrich .id = 1, 97f686e9afSMarc Dietrich }, 98f686e9afSMarc Dietrich { 99f686e9afSMarc Dietrich .name = "nvec-power", 100f686e9afSMarc Dietrich .id = 2, 101f686e9afSMarc Dietrich }, 10297cc2657SIlya Petrov { 103ac562680SMarc Dietrich .name = "nvec-paz00", 10497cc2657SIlya Petrov .id = 1, 10597cc2657SIlya Petrov }, 106f686e9afSMarc Dietrich }; 107f686e9afSMarc Dietrich 108bdf034d9SJulian Andres Klode /** 109bdf034d9SJulian Andres Klode * nvec_register_notifier - Register a notifier with nvec 110bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 111bdf034d9SJulian Andres Klode * @nb: The notifier block to register 112bdf034d9SJulian Andres Klode * 113bdf034d9SJulian Andres Klode * Registers a notifier with @nvec. The notifier will be added to an atomic 114bdf034d9SJulian Andres Klode * notifier chain that is called for all received messages except those that 115bdf034d9SJulian Andres Klode * correspond to a request initiated by nvec_write_sync(). 116bdf034d9SJulian Andres Klode */ 11732890b98SMarc Dietrich int nvec_register_notifier(struct nvec_chip *nvec, struct notifier_block *nb, 11832890b98SMarc Dietrich unsigned int events) 11932890b98SMarc Dietrich { 12032890b98SMarc Dietrich return atomic_notifier_chain_register(&nvec->notifier_list, nb); 12132890b98SMarc Dietrich } 12232890b98SMarc Dietrich EXPORT_SYMBOL_GPL(nvec_register_notifier); 12332890b98SMarc Dietrich 124bdf034d9SJulian Andres Klode /** 125111c1587SMarc Dietrich * nvec_unregister_notifier - Unregister a notifier with nvec 126111c1587SMarc Dietrich * @nvec: A &struct nvec_chip 127111c1587SMarc Dietrich * @nb: The notifier block to unregister 128111c1587SMarc Dietrich * 129111c1587SMarc Dietrich * Unregisters a notifier with @nvec. The notifier will be removed from the 130111c1587SMarc Dietrich * atomic notifier chain. 131111c1587SMarc Dietrich */ 132111c1587SMarc Dietrich int nvec_unregister_notifier(struct nvec_chip *nvec, struct notifier_block *nb) 133111c1587SMarc Dietrich { 134111c1587SMarc Dietrich return atomic_notifier_chain_unregister(&nvec->notifier_list, nb); 135111c1587SMarc Dietrich } 136111c1587SMarc Dietrich EXPORT_SYMBOL_GPL(nvec_unregister_notifier); 137111c1587SMarc Dietrich 138111c1587SMarc Dietrich /** 139bdf034d9SJulian Andres Klode * nvec_status_notifier - The final notifier 140bdf034d9SJulian Andres Klode * 141bdf034d9SJulian Andres Klode * Prints a message about control events not handled in the notifier 142bdf034d9SJulian Andres Klode * chain. 143bdf034d9SJulian Andres Klode */ 144162c7d8cSMarc Dietrich static int nvec_status_notifier(struct notifier_block *nb, 145162c7d8cSMarc Dietrich unsigned long event_type, void *data) 14632890b98SMarc Dietrich { 14750d4656aSMarc Dietrich struct nvec_chip *nvec = container_of(nb, struct nvec_chip, 14850d4656aSMarc Dietrich nvec_status_notifier); 14932890b98SMarc Dietrich unsigned char *msg = (unsigned char *)data; 15032890b98SMarc Dietrich 15132890b98SMarc Dietrich if (event_type != NVEC_CNTL) 15232890b98SMarc Dietrich return NOTIFY_DONE; 15332890b98SMarc Dietrich 15450d4656aSMarc Dietrich dev_warn(nvec->dev, "unhandled msg type %ld\n", event_type); 155a3a9aa1aSMarc Dietrich print_hex_dump(KERN_WARNING, "payload: ", DUMP_PREFIX_NONE, 16, 1, 156a3a9aa1aSMarc Dietrich msg, msg[1] + 2, true); 15732890b98SMarc Dietrich 15832890b98SMarc Dietrich return NOTIFY_OK; 15932890b98SMarc Dietrich } 16032890b98SMarc Dietrich 161bdf034d9SJulian Andres Klode /** 162bdf034d9SJulian Andres Klode * nvec_msg_alloc: 163bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 164bb0590e2SJulian Andres Klode * @category: Pool category, see &enum nvec_msg_category 165bdf034d9SJulian Andres Klode * 166bdf034d9SJulian Andres Klode * Allocate a single &struct nvec_msg object from the message pool of 167bdf034d9SJulian Andres Klode * @nvec. The result shall be passed to nvec_msg_free() if no longer 168bdf034d9SJulian Andres Klode * used. 169bb0590e2SJulian Andres Klode * 170bb0590e2SJulian Andres Klode * Outgoing messages are placed in the upper 75% of the pool, keeping the 171bb0590e2SJulian Andres Klode * lower 25% available for RX buffers only. The reason is to prevent a 172bb0590e2SJulian Andres Klode * situation where all buffers are full and a message is thus endlessly 173bb0590e2SJulian Andres Klode * retried because the response could never be processed. 174bdf034d9SJulian Andres Klode */ 175bb0590e2SJulian Andres Klode static struct nvec_msg *nvec_msg_alloc(struct nvec_chip *nvec, 176bb0590e2SJulian Andres Klode enum nvec_msg_category category) 1770b1076c4SJulian Andres Klode { 178bb0590e2SJulian Andres Klode int i = (category == NVEC_MSG_TX) ? (NVEC_POOL_SIZE / 4) : 0; 1790b1076c4SJulian Andres Klode 180bb0590e2SJulian Andres Klode for (; i < NVEC_POOL_SIZE; i++) { 1810b1076c4SJulian Andres Klode if (atomic_xchg(&nvec->msg_pool[i].used, 1) == 0) { 1820b1076c4SJulian Andres Klode dev_vdbg(nvec->dev, "INFO: Allocate %i\n", i); 1830b1076c4SJulian Andres Klode return &nvec->msg_pool[i]; 1840b1076c4SJulian Andres Klode } 1850b1076c4SJulian Andres Klode } 1860b1076c4SJulian Andres Klode 187bb0590e2SJulian Andres Klode dev_err(nvec->dev, "could not allocate %s buffer\n", 188bb0590e2SJulian Andres Klode (category == NVEC_MSG_TX) ? "TX" : "RX"); 1890b1076c4SJulian Andres Klode 1900b1076c4SJulian Andres Klode return NULL; 1910b1076c4SJulian Andres Klode } 1920b1076c4SJulian Andres Klode 193bdf034d9SJulian Andres Klode /** 194bdf034d9SJulian Andres Klode * nvec_msg_free: 195bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 196bdf034d9SJulian Andres Klode * @msg: A message (must be allocated by nvec_msg_alloc() and belong to @nvec) 197bdf034d9SJulian Andres Klode * 198bdf034d9SJulian Andres Klode * Free the given message 199bdf034d9SJulian Andres Klode */ 200705a4212SDenis Efremov void nvec_msg_free(struct nvec_chip *nvec, struct nvec_msg *msg) 2010b1076c4SJulian Andres Klode { 2027b770657SJulian Andres Klode if (msg != &nvec->tx_scratch) 2030b1076c4SJulian Andres Klode dev_vdbg(nvec->dev, "INFO: Free %ti\n", msg - nvec->msg_pool); 2040b1076c4SJulian Andres Klode atomic_set(&msg->used, 0); 2050b1076c4SJulian Andres Klode } 206198dd267SJulian Andres Klode EXPORT_SYMBOL_GPL(nvec_msg_free); 2070b1076c4SJulian Andres Klode 2088517e879SJulian Andres Klode /** 2098517e879SJulian Andres Klode * nvec_msg_is_event - Return %true if @msg is an event 2108517e879SJulian Andres Klode * @msg: A message 2118517e879SJulian Andres Klode */ 2128517e879SJulian Andres Klode static bool nvec_msg_is_event(struct nvec_msg *msg) 2138517e879SJulian Andres Klode { 2148517e879SJulian Andres Klode return msg->data[0] >> 7; 2158517e879SJulian Andres Klode } 2168517e879SJulian Andres Klode 2178517e879SJulian Andres Klode /** 2188517e879SJulian Andres Klode * nvec_msg_size - Get the size of a message 2198517e879SJulian Andres Klode * @msg: The message to get the size for 2208517e879SJulian Andres Klode * 2218517e879SJulian Andres Klode * This only works for received messages, not for outgoing messages. 2228517e879SJulian Andres Klode */ 2238517e879SJulian Andres Klode static size_t nvec_msg_size(struct nvec_msg *msg) 2248517e879SJulian Andres Klode { 2258517e879SJulian Andres Klode bool is_event = nvec_msg_is_event(msg); 2268517e879SJulian Andres Klode int event_length = (msg->data[0] & 0x60) >> 5; 2278517e879SJulian Andres Klode 2288517e879SJulian Andres Klode /* for variable size, payload size in byte 1 + count (1) + cmd (1) */ 2298517e879SJulian Andres Klode if (!is_event || event_length == NVEC_VAR_SIZE) 2308517e879SJulian Andres Klode return (msg->pos || msg->size) ? (msg->data[1] + 2) : 0; 2318517e879SJulian Andres Klode else if (event_length == NVEC_2BYTES) 2328517e879SJulian Andres Klode return 2; 2338517e879SJulian Andres Klode else if (event_length == NVEC_3BYTES) 2348517e879SJulian Andres Klode return 3; 2358517e879SJulian Andres Klode else 2368517e879SJulian Andres Klode return 0; 2378517e879SJulian Andres Klode } 2388517e879SJulian Andres Klode 239bdf034d9SJulian Andres Klode /** 240bdf034d9SJulian Andres Klode * nvec_gpio_set_value - Set the GPIO value 241bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 242bdf034d9SJulian Andres Klode * @value: The value to write (0 or 1) 243bdf034d9SJulian Andres Klode * 244bdf034d9SJulian Andres Klode * Like gpio_set_value(), but generating debugging information 245bdf034d9SJulian Andres Klode */ 246e7c40851SJulian Andres Klode static void nvec_gpio_set_value(struct nvec_chip *nvec, int value) 247e7c40851SJulian Andres Klode { 248e7c40851SJulian Andres Klode dev_dbg(nvec->dev, "GPIO changed from %u to %u\n", 249e7c40851SJulian Andres Klode gpio_get_value(nvec->gpio), value); 250e7c40851SJulian Andres Klode gpio_set_value(nvec->gpio, value); 251e7c40851SJulian Andres Klode } 252e7c40851SJulian Andres Klode 253bdf034d9SJulian Andres Klode /** 254bdf034d9SJulian Andres Klode * nvec_write_async - Asynchronously write a message to NVEC 255bdf034d9SJulian Andres Klode * @nvec: An nvec_chip instance 256bdf034d9SJulian Andres Klode * @data: The message data, starting with the request type 257bdf034d9SJulian Andres Klode * @size: The size of @data 258bdf034d9SJulian Andres Klode * 259bdf034d9SJulian Andres Klode * Queue a single message to be transferred to the embedded controller 260bdf034d9SJulian Andres Klode * and return immediately. 261bdf034d9SJulian Andres Klode * 262bdf034d9SJulian Andres Klode * Returns: 0 on success, a negative error code on failure. If a failure 263bdf034d9SJulian Andres Klode * occured, the nvec driver may print an error. 264bdf034d9SJulian Andres Klode */ 2651b9bf629SJulian Andres Klode int nvec_write_async(struct nvec_chip *nvec, const unsigned char *data, 266162c7d8cSMarc Dietrich short size) 26732890b98SMarc Dietrich { 2680cab4cb8SJulian Andres Klode struct nvec_msg *msg; 2690cab4cb8SJulian Andres Klode unsigned long flags; 27032890b98SMarc Dietrich 271bb0590e2SJulian Andres Klode msg = nvec_msg_alloc(nvec, NVEC_MSG_TX); 272bb0590e2SJulian Andres Klode 2731b9bf629SJulian Andres Klode if (msg == NULL) 2741b9bf629SJulian Andres Klode return -ENOMEM; 2751b9bf629SJulian Andres Klode 27632890b98SMarc Dietrich msg->data[0] = size; 27732890b98SMarc Dietrich memcpy(msg->data + 1, data, size); 27832890b98SMarc Dietrich msg->size = size + 1; 27932890b98SMarc Dietrich 2800cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags); 28132890b98SMarc Dietrich list_add_tail(&msg->node, &nvec->tx_data); 2820cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags); 28332890b98SMarc Dietrich 284033d9959SLinus Torvalds schedule_work(&nvec->tx_work); 2851b9bf629SJulian Andres Klode 2861b9bf629SJulian Andres Klode return 0; 28732890b98SMarc Dietrich } 28832890b98SMarc Dietrich EXPORT_SYMBOL(nvec_write_async); 28932890b98SMarc Dietrich 290bdf034d9SJulian Andres Klode /** 291bdf034d9SJulian Andres Klode * nvec_write_sync - Write a message to nvec and read the response 292bdf034d9SJulian Andres Klode * @nvec: An &struct nvec_chip 293bdf034d9SJulian Andres Klode * @data: The data to write 294bdf034d9SJulian Andres Klode * @size: The size of @data 295bdf034d9SJulian Andres Klode * 296bdf034d9SJulian Andres Klode * This is similar to nvec_write_async(), but waits for the 297bdf034d9SJulian Andres Klode * request to be answered before returning. This function 298bdf034d9SJulian Andres Klode * uses a mutex and can thus not be called from e.g. 299bdf034d9SJulian Andres Klode * interrupt handlers. 300bdf034d9SJulian Andres Klode * 301bdf034d9SJulian Andres Klode * Returns: A pointer to the response message on success, 302198dd267SJulian Andres Klode * %NULL on failure. Free with nvec_msg_free() once no longer 303198dd267SJulian Andres Klode * used. 304bdf034d9SJulian Andres Klode */ 3050cab4cb8SJulian Andres Klode struct nvec_msg *nvec_write_sync(struct nvec_chip *nvec, 3060cab4cb8SJulian Andres Klode const unsigned char *data, short size) 3070cab4cb8SJulian Andres Klode { 3080cab4cb8SJulian Andres Klode struct nvec_msg *msg; 3090cab4cb8SJulian Andres Klode 3100cab4cb8SJulian Andres Klode mutex_lock(&nvec->sync_write_mutex); 3110cab4cb8SJulian Andres Klode 3120cab4cb8SJulian Andres Klode nvec->sync_write_pending = (data[1] << 8) + data[0]; 3131b9bf629SJulian Andres Klode 3144b8bf03dSMarc Dietrich if (nvec_write_async(nvec, data, size) < 0) { 3154b8bf03dSMarc Dietrich mutex_unlock(&nvec->sync_write_mutex); 3161b9bf629SJulian Andres Klode return NULL; 3174b8bf03dSMarc Dietrich } 3180cab4cb8SJulian Andres Klode 3190cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "nvec_sync_write: 0x%04x\n", 3200cab4cb8SJulian Andres Klode nvec->sync_write_pending); 3210cab4cb8SJulian Andres Klode if (!(wait_for_completion_timeout(&nvec->sync_write, 3220cab4cb8SJulian Andres Klode msecs_to_jiffies(2000)))) { 3230cab4cb8SJulian Andres Klode dev_warn(nvec->dev, "timeout waiting for sync write to complete\n"); 3240cab4cb8SJulian Andres Klode mutex_unlock(&nvec->sync_write_mutex); 3250cab4cb8SJulian Andres Klode return NULL; 3260cab4cb8SJulian Andres Klode } 3270cab4cb8SJulian Andres Klode 3280cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "nvec_sync_write: pong!\n"); 3290cab4cb8SJulian Andres Klode 3300cab4cb8SJulian Andres Klode msg = nvec->last_sync_msg; 3310cab4cb8SJulian Andres Klode 3320cab4cb8SJulian Andres Klode mutex_unlock(&nvec->sync_write_mutex); 3330cab4cb8SJulian Andres Klode 3340cab4cb8SJulian Andres Klode return msg; 3350cab4cb8SJulian Andres Klode } 3360cab4cb8SJulian Andres Klode EXPORT_SYMBOL(nvec_write_sync); 3370cab4cb8SJulian Andres Klode 338bdf034d9SJulian Andres Klode /** 339518945fbSMarc Dietrich * nvec_toggle_global_events - enables or disables global event reporting 340518945fbSMarc Dietrich * @nvec: nvec handle 341518945fbSMarc Dietrich * @state: true for enable, false for disable 342518945fbSMarc Dietrich * 343518945fbSMarc Dietrich * This switches on/off global event reports by the embedded controller. 344518945fbSMarc Dietrich */ 345518945fbSMarc Dietrich static void nvec_toggle_global_events(struct nvec_chip *nvec, bool state) 346518945fbSMarc Dietrich { 347518945fbSMarc Dietrich unsigned char global_events[] = { NVEC_SLEEP, GLOBAL_EVENTS, state }; 348518945fbSMarc Dietrich 349518945fbSMarc Dietrich nvec_write_async(nvec, global_events, 3); 350518945fbSMarc Dietrich } 351518945fbSMarc Dietrich 352518945fbSMarc Dietrich /** 35393eff83fSMarc Dietrich * nvec_event_mask - fill the command string with event bitfield 35493eff83fSMarc Dietrich * ev: points to event command string 35593eff83fSMarc Dietrich * mask: bit to insert into the event mask 35693eff83fSMarc Dietrich * 35793eff83fSMarc Dietrich * Configure event command expects a 32 bit bitfield which describes 35893eff83fSMarc Dietrich * which events to enable. The bitfield has the following structure 35993eff83fSMarc Dietrich * (from highest byte to lowest): 36093eff83fSMarc Dietrich * system state bits 7-0 36193eff83fSMarc Dietrich * system state bits 15-8 36293eff83fSMarc Dietrich * oem system state bits 7-0 36393eff83fSMarc Dietrich * oem system state bits 15-8 36493eff83fSMarc Dietrich */ 36593eff83fSMarc Dietrich static void nvec_event_mask(char *ev, u32 mask) 36693eff83fSMarc Dietrich { 367815fb010SWei Yongjun ev[3] = mask >> 16 & 0xff; 368815fb010SWei Yongjun ev[4] = mask >> 24 & 0xff; 369815fb010SWei Yongjun ev[5] = mask >> 0 & 0xff; 370815fb010SWei Yongjun ev[6] = mask >> 8 & 0xff; 37193eff83fSMarc Dietrich } 37293eff83fSMarc Dietrich 37393eff83fSMarc Dietrich /** 374bdf034d9SJulian Andres Klode * nvec_request_master - Process outgoing messages 375bdf034d9SJulian Andres Klode * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip) 376bdf034d9SJulian Andres Klode * 377bdf034d9SJulian Andres Klode * Processes all outgoing requests by sending the request and awaiting the 378bdf034d9SJulian Andres Klode * response, then continuing with the next request. Once a request has a 379bdf034d9SJulian Andres Klode * matching response, it will be freed and removed from the list. 380bdf034d9SJulian Andres Klode */ 38132890b98SMarc Dietrich static void nvec_request_master(struct work_struct *work) 38232890b98SMarc Dietrich { 38332890b98SMarc Dietrich struct nvec_chip *nvec = container_of(work, struct nvec_chip, tx_work); 3840cab4cb8SJulian Andres Klode unsigned long flags; 3850cab4cb8SJulian Andres Klode long err; 3860cab4cb8SJulian Andres Klode struct nvec_msg *msg; 38732890b98SMarc Dietrich 3880cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags); 3890cab4cb8SJulian Andres Klode while (!list_empty(&nvec->tx_data)) { 3900cab4cb8SJulian Andres Klode msg = list_first_entry(&nvec->tx_data, struct nvec_msg, node); 3910cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags); 3920cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 0); 3930cab4cb8SJulian Andres Klode err = wait_for_completion_interruptible_timeout( 3940cab4cb8SJulian Andres Klode &nvec->ec_transfer, msecs_to_jiffies(5000)); 3950cab4cb8SJulian Andres Klode 3960cab4cb8SJulian Andres Klode if (err == 0) { 3970cab4cb8SJulian Andres Klode dev_warn(nvec->dev, "timeout waiting for ec transfer\n"); 3980cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 1); 3990cab4cb8SJulian Andres Klode msg->pos = 0; 4000cab4cb8SJulian Andres Klode } 4010cab4cb8SJulian Andres Klode 4020cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags); 4030cab4cb8SJulian Andres Klode 4040cab4cb8SJulian Andres Klode if (err > 0) { 4050cab4cb8SJulian Andres Klode list_del_init(&msg->node); 4060cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg); 4070cab4cb8SJulian Andres Klode } 4080cab4cb8SJulian Andres Klode } 4090cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags); 41032890b98SMarc Dietrich } 41132890b98SMarc Dietrich 412bdf034d9SJulian Andres Klode /** 413bdf034d9SJulian Andres Klode * parse_msg - Print some information and call the notifiers on an RX message 414bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 415bdf034d9SJulian Andres Klode * @msg: A message received by @nvec 416bdf034d9SJulian Andres Klode * 417bdf034d9SJulian Andres Klode * Paarse some pieces of the message and then call the chain of notifiers 418bdf034d9SJulian Andres Klode * registered via nvec_register_notifier. 419bdf034d9SJulian Andres Klode */ 42032890b98SMarc Dietrich static int parse_msg(struct nvec_chip *nvec, struct nvec_msg *msg) 42132890b98SMarc Dietrich { 42232890b98SMarc Dietrich if ((msg->data[0] & 1 << 7) == 0 && msg->data[3]) { 4236a371978SAndy Shevchenko dev_err(nvec->dev, "ec responded %*ph\n", 4, msg->data); 42432890b98SMarc Dietrich return -EINVAL; 42532890b98SMarc Dietrich } 42632890b98SMarc Dietrich 427a3a9aa1aSMarc Dietrich if ((msg->data[0] >> 7) == 1 && (msg->data[0] & 0x0f) == 5) 428a3a9aa1aSMarc Dietrich print_hex_dump(KERN_WARNING, "ec system event ", 429a3a9aa1aSMarc Dietrich DUMP_PREFIX_NONE, 16, 1, msg->data, 430a3a9aa1aSMarc Dietrich msg->data[1] + 2, true); 43132890b98SMarc Dietrich 432162c7d8cSMarc Dietrich atomic_notifier_call_chain(&nvec->notifier_list, msg->data[0] & 0x8f, 433162c7d8cSMarc Dietrich msg->data); 43432890b98SMarc Dietrich 43532890b98SMarc Dietrich return 0; 43632890b98SMarc Dietrich } 43732890b98SMarc Dietrich 438bdf034d9SJulian Andres Klode /** 439bdf034d9SJulian Andres Klode * nvec_dispatch - Process messages received from the EC 440bdf034d9SJulian Andres Klode * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip) 441bdf034d9SJulian Andres Klode * 442bdf034d9SJulian Andres Klode * Process messages previously received from the EC and put into the RX 443bdf034d9SJulian Andres Klode * queue of the &struct nvec_chip instance associated with @work. 444bdf034d9SJulian Andres Klode */ 44532890b98SMarc Dietrich static void nvec_dispatch(struct work_struct *work) 44632890b98SMarc Dietrich { 44732890b98SMarc Dietrich struct nvec_chip *nvec = container_of(work, struct nvec_chip, rx_work); 4480cab4cb8SJulian Andres Klode unsigned long flags; 44932890b98SMarc Dietrich struct nvec_msg *msg; 45032890b98SMarc Dietrich 4510cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->rx_lock, flags); 452162c7d8cSMarc Dietrich while (!list_empty(&nvec->rx_data)) { 45332890b98SMarc Dietrich msg = list_first_entry(&nvec->rx_data, struct nvec_msg, node); 45432890b98SMarc Dietrich list_del_init(&msg->node); 4550cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->rx_lock, flags); 45632890b98SMarc Dietrich 457162c7d8cSMarc Dietrich if (nvec->sync_write_pending == 458162c7d8cSMarc Dietrich (msg->data[2] << 8) + msg->data[0]) { 45932890b98SMarc Dietrich dev_dbg(nvec->dev, "sync write completed!\n"); 46032890b98SMarc Dietrich nvec->sync_write_pending = 0; 46132890b98SMarc Dietrich nvec->last_sync_msg = msg; 46232890b98SMarc Dietrich complete(&nvec->sync_write); 46332890b98SMarc Dietrich } else { 46432890b98SMarc Dietrich parse_msg(nvec, msg); 4650cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg); 46632890b98SMarc Dietrich } 4670cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->rx_lock, flags); 46832890b98SMarc Dietrich } 4690cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->rx_lock, flags); 4700cab4cb8SJulian Andres Klode } 4710cab4cb8SJulian Andres Klode 472bdf034d9SJulian Andres Klode /** 473bdf034d9SJulian Andres Klode * nvec_tx_completed - Complete the current transfer 474bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 475bdf034d9SJulian Andres Klode * 476bdf034d9SJulian Andres Klode * This is called when we have received an END_TRANS on a TX transfer. 477bdf034d9SJulian Andres Klode */ 4780cab4cb8SJulian Andres Klode static void nvec_tx_completed(struct nvec_chip *nvec) 4790cab4cb8SJulian Andres Klode { 4800cab4cb8SJulian Andres Klode /* We got an END_TRANS, let's skip this, maybe there's an event */ 4810cab4cb8SJulian Andres Klode if (nvec->tx->pos != nvec->tx->size) { 4820cab4cb8SJulian Andres Klode dev_err(nvec->dev, "premature END_TRANS, resending\n"); 4830cab4cb8SJulian Andres Klode nvec->tx->pos = 0; 4840cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 0); 4850cab4cb8SJulian Andres Klode } else { 4860cab4cb8SJulian Andres Klode nvec->state = 0; 48732890b98SMarc Dietrich } 48832890b98SMarc Dietrich } 48932890b98SMarc Dietrich 490bdf034d9SJulian Andres Klode /** 491bdf034d9SJulian Andres Klode * nvec_rx_completed - Complete the current transfer 492bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 493bdf034d9SJulian Andres Klode * 494bdf034d9SJulian Andres Klode * This is called when we have received an END_TRANS on a RX transfer. 495bdf034d9SJulian Andres Klode */ 4960cab4cb8SJulian Andres Klode static void nvec_rx_completed(struct nvec_chip *nvec) 4970cab4cb8SJulian Andres Klode { 498210ceb4fSJulian Andres Klode if (nvec->rx->pos != nvec_msg_size(nvec->rx)) { 4990cab4cb8SJulian Andres Klode dev_err(nvec->dev, "RX incomplete: Expected %u bytes, got %u\n", 5000cab4cb8SJulian Andres Klode (uint) nvec_msg_size(nvec->rx), 5010cab4cb8SJulian Andres Klode (uint) nvec->rx->pos); 5020cab4cb8SJulian Andres Klode 503210ceb4fSJulian Andres Klode nvec_msg_free(nvec, nvec->rx); 504210ceb4fSJulian Andres Klode nvec->state = 0; 505d6bdcf2eSJulian Andres Klode 506d6bdcf2eSJulian Andres Klode /* Battery quirk - Often incomplete, and likes to crash */ 507d6bdcf2eSJulian Andres Klode if (nvec->rx->data[0] == NVEC_BAT) 508d6bdcf2eSJulian Andres Klode complete(&nvec->ec_transfer); 509d6bdcf2eSJulian Andres Klode 510210ceb4fSJulian Andres Klode return; 511210ceb4fSJulian Andres Klode } 512210ceb4fSJulian Andres Klode 5130cab4cb8SJulian Andres Klode spin_lock(&nvec->rx_lock); 5140cab4cb8SJulian Andres Klode 5150cab4cb8SJulian Andres Klode /* add the received data to the work list 5160cab4cb8SJulian Andres Klode and move the ring buffer pointer to the next entry */ 5170cab4cb8SJulian Andres Klode list_add_tail(&nvec->rx->node, &nvec->rx_data); 5180cab4cb8SJulian Andres Klode 5190cab4cb8SJulian Andres Klode spin_unlock(&nvec->rx_lock); 5200cab4cb8SJulian Andres Klode 5210cab4cb8SJulian Andres Klode nvec->state = 0; 5220cab4cb8SJulian Andres Klode 5230cab4cb8SJulian Andres Klode if (!nvec_msg_is_event(nvec->rx)) 5240cab4cb8SJulian Andres Klode complete(&nvec->ec_transfer); 5250cab4cb8SJulian Andres Klode 526033d9959SLinus Torvalds schedule_work(&nvec->rx_work); 5270cab4cb8SJulian Andres Klode } 5280cab4cb8SJulian Andres Klode 5290cab4cb8SJulian Andres Klode /** 5300cab4cb8SJulian Andres Klode * nvec_invalid_flags - Send an error message about invalid flags and jump 5310cab4cb8SJulian Andres Klode * @nvec: The nvec device 5320cab4cb8SJulian Andres Klode * @status: The status flags 5330cab4cb8SJulian Andres Klode * @reset: Whether we shall jump to state 0. 5340cab4cb8SJulian Andres Klode */ 5350cab4cb8SJulian Andres Klode static void nvec_invalid_flags(struct nvec_chip *nvec, unsigned int status, 5360cab4cb8SJulian Andres Klode bool reset) 5370cab4cb8SJulian Andres Klode { 5380cab4cb8SJulian Andres Klode dev_err(nvec->dev, "unexpected status flags 0x%02x during state %i\n", 5390cab4cb8SJulian Andres Klode status, nvec->state); 5400cab4cb8SJulian Andres Klode if (reset) 5410cab4cb8SJulian Andres Klode nvec->state = 0; 5420cab4cb8SJulian Andres Klode } 5430cab4cb8SJulian Andres Klode 5440cab4cb8SJulian Andres Klode /** 5450cab4cb8SJulian Andres Klode * nvec_tx_set - Set the message to transfer (nvec->tx) 546bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 547bdf034d9SJulian Andres Klode * 548bdf034d9SJulian Andres Klode * Gets the first entry from the tx_data list of @nvec and sets the 549bdf034d9SJulian Andres Klode * tx member to it. If the tx_data list is empty, this uses the 550bdf034d9SJulian Andres Klode * tx_scratch message to send a no operation message. 5510cab4cb8SJulian Andres Klode */ 5520cab4cb8SJulian Andres Klode static void nvec_tx_set(struct nvec_chip *nvec) 5530cab4cb8SJulian Andres Klode { 5540cab4cb8SJulian Andres Klode spin_lock(&nvec->tx_lock); 5550cab4cb8SJulian Andres Klode if (list_empty(&nvec->tx_data)) { 5560cab4cb8SJulian Andres Klode dev_err(nvec->dev, "empty tx - sending no-op\n"); 5570cab4cb8SJulian Andres Klode memcpy(nvec->tx_scratch.data, "\x02\x07\x02", 3); 5580cab4cb8SJulian Andres Klode nvec->tx_scratch.size = 3; 5590cab4cb8SJulian Andres Klode nvec->tx_scratch.pos = 0; 5600cab4cb8SJulian Andres Klode nvec->tx = &nvec->tx_scratch; 5610cab4cb8SJulian Andres Klode list_add_tail(&nvec->tx->node, &nvec->tx_data); 5620cab4cb8SJulian Andres Klode } else { 5630cab4cb8SJulian Andres Klode nvec->tx = list_first_entry(&nvec->tx_data, struct nvec_msg, 5640cab4cb8SJulian Andres Klode node); 5650cab4cb8SJulian Andres Klode nvec->tx->pos = 0; 5660cab4cb8SJulian Andres Klode } 5670cab4cb8SJulian Andres Klode spin_unlock(&nvec->tx_lock); 5680cab4cb8SJulian Andres Klode 5690cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "Sending message of length %u, command 0x%x\n", 5700cab4cb8SJulian Andres Klode (uint)nvec->tx->size, nvec->tx->data[1]); 5710cab4cb8SJulian Andres Klode } 5720cab4cb8SJulian Andres Klode 5730cab4cb8SJulian Andres Klode /** 5740cab4cb8SJulian Andres Klode * nvec_interrupt - Interrupt handler 5750cab4cb8SJulian Andres Klode * @irq: The IRQ 5760cab4cb8SJulian Andres Klode * @dev: The nvec device 577bdf034d9SJulian Andres Klode * 578bdf034d9SJulian Andres Klode * Interrupt handler that fills our RX buffers and empties our TX 579bdf034d9SJulian Andres Klode * buffers. This uses a finite state machine with ridiculous amounts 580bdf034d9SJulian Andres Klode * of error checking, in order to be fairly reliable. 5810cab4cb8SJulian Andres Klode */ 582f686e9afSMarc Dietrich static irqreturn_t nvec_interrupt(int irq, void *dev) 58332890b98SMarc Dietrich { 58432890b98SMarc Dietrich unsigned long status; 5850cab4cb8SJulian Andres Klode unsigned int received = 0; 5860cab4cb8SJulian Andres Klode unsigned char to_send = 0xff; 5870cab4cb8SJulian Andres Klode const unsigned long irq_mask = I2C_SL_IRQ | END_TRANS | RCVD | RNW; 5880cab4cb8SJulian Andres Klode struct nvec_chip *nvec = dev; 5890cab4cb8SJulian Andres Klode unsigned int state = nvec->state; 59032890b98SMarc Dietrich 5910cab4cb8SJulian Andres Klode status = readl(nvec->base + I2C_SL_STATUS); 59232890b98SMarc Dietrich 5930cab4cb8SJulian Andres Klode /* Filter out some errors */ 5940cab4cb8SJulian Andres Klode if ((status & irq_mask) == 0 && (status & ~irq_mask) != 0) { 5950cab4cb8SJulian Andres Klode dev_err(nvec->dev, "unexpected irq mask %lx\n", status); 59632890b98SMarc Dietrich return IRQ_HANDLED; 5970cab4cb8SJulian Andres Klode } 5980cab4cb8SJulian Andres Klode if ((status & I2C_SL_IRQ) == 0) { 5990cab4cb8SJulian Andres Klode dev_err(nvec->dev, "Spurious IRQ\n"); 6000cab4cb8SJulian Andres Klode return IRQ_HANDLED; 6010cab4cb8SJulian Andres Klode } 6020cab4cb8SJulian Andres Klode 6030cab4cb8SJulian Andres Klode /* The EC did not request a read, so it send us something, read it */ 6040cab4cb8SJulian Andres Klode if ((status & RNW) == 0) { 6050cab4cb8SJulian Andres Klode received = readl(nvec->base + I2C_SL_RCVD); 60632890b98SMarc Dietrich if (status & RCVD) 6070cab4cb8SJulian Andres Klode writel(0, nvec->base + I2C_SL_RCVD); 6080cab4cb8SJulian Andres Klode } 60932890b98SMarc Dietrich 6100cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RCVD)) 6110cab4cb8SJulian Andres Klode nvec->state = 0; 612162c7d8cSMarc Dietrich 6130cab4cb8SJulian Andres Klode switch (nvec->state) { 6140cab4cb8SJulian Andres Klode case 0: /* Verify that its a transfer start, the rest later */ 6150cab4cb8SJulian Andres Klode if (status != (I2C_SL_IRQ | RCVD)) 6160cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, false); 6170cab4cb8SJulian Andres Klode break; 6180cab4cb8SJulian Andres Klode case 1: /* command byte */ 6190cab4cb8SJulian Andres Klode if (status != I2C_SL_IRQ) { 6200cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 62132890b98SMarc Dietrich } else { 622bb0590e2SJulian Andres Klode nvec->rx = nvec_msg_alloc(nvec, NVEC_MSG_RX); 6238da79863SJulian Andres Klode /* Should not happen in a normal world */ 6248da79863SJulian Andres Klode if (unlikely(nvec->rx == NULL)) { 6258da79863SJulian Andres Klode nvec->state = 0; 6268da79863SJulian Andres Klode break; 6278da79863SJulian Andres Klode } 6280cab4cb8SJulian Andres Klode nvec->rx->data[0] = received; 6290cab4cb8SJulian Andres Klode nvec->rx->pos = 1; 6300cab4cb8SJulian Andres Klode nvec->state = 2; 6310cab4cb8SJulian Andres Klode } 6320cab4cb8SJulian Andres Klode break; 6330cab4cb8SJulian Andres Klode case 2: /* first byte after command */ 6340cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RNW | RCVD)) { 6350cab4cb8SJulian Andres Klode udelay(33); 6360cab4cb8SJulian Andres Klode if (nvec->rx->data[0] != 0x01) { 6370cab4cb8SJulian Andres Klode dev_err(nvec->dev, 6380cab4cb8SJulian Andres Klode "Read without prior read command\n"); 6390cab4cb8SJulian Andres Klode nvec->state = 0; 6400cab4cb8SJulian Andres Klode break; 6410cab4cb8SJulian Andres Klode } 6420cab4cb8SJulian Andres Klode nvec_msg_free(nvec, nvec->rx); 6430cab4cb8SJulian Andres Klode nvec->state = 3; 6440cab4cb8SJulian Andres Klode nvec_tx_set(nvec); 6450cab4cb8SJulian Andres Klode BUG_ON(nvec->tx->size < 1); 6460cab4cb8SJulian Andres Klode to_send = nvec->tx->data[0]; 6470cab4cb8SJulian Andres Klode nvec->tx->pos = 1; 6480cab4cb8SJulian Andres Klode } else if (status == (I2C_SL_IRQ)) { 6490cab4cb8SJulian Andres Klode BUG_ON(nvec->rx == NULL); 6500cab4cb8SJulian Andres Klode nvec->rx->data[1] = received; 6510cab4cb8SJulian Andres Klode nvec->rx->pos = 2; 6520cab4cb8SJulian Andres Klode nvec->state = 4; 65332890b98SMarc Dietrich } else { 6540cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 65532890b98SMarc Dietrich } 6560cab4cb8SJulian Andres Klode break; 6570cab4cb8SJulian Andres Klode case 3: /* EC does a block read, we transmit data */ 6580cab4cb8SJulian Andres Klode if (status & END_TRANS) { 6590cab4cb8SJulian Andres Klode nvec_tx_completed(nvec); 6600cab4cb8SJulian Andres Klode } else if ((status & RNW) == 0 || (status & RCVD)) { 6610cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 6620cab4cb8SJulian Andres Klode } else if (nvec->tx && nvec->tx->pos < nvec->tx->size) { 6630cab4cb8SJulian Andres Klode to_send = nvec->tx->data[nvec->tx->pos++]; 66432890b98SMarc Dietrich } else { 6650cab4cb8SJulian Andres Klode dev_err(nvec->dev, "tx buffer underflow on %p (%u > %u)\n", 6660cab4cb8SJulian Andres Klode nvec->tx, 6670cab4cb8SJulian Andres Klode (uint) (nvec->tx ? nvec->tx->pos : 0), 6680cab4cb8SJulian Andres Klode (uint) (nvec->tx ? nvec->tx->size : 0)); 6690cab4cb8SJulian Andres Klode nvec->state = 0; 6700cab4cb8SJulian Andres Klode } 6710cab4cb8SJulian Andres Klode break; 6720cab4cb8SJulian Andres Klode case 4: /* EC does some write, we read the data */ 6730cab4cb8SJulian Andres Klode if ((status & (END_TRANS | RNW)) == END_TRANS) 6740cab4cb8SJulian Andres Klode nvec_rx_completed(nvec); 6750cab4cb8SJulian Andres Klode else if (status & (RNW | RCVD)) 6760cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 6770cab4cb8SJulian Andres Klode else if (nvec->rx && nvec->rx->pos < NVEC_MSG_SIZE) 6780cab4cb8SJulian Andres Klode nvec->rx->data[nvec->rx->pos++] = received; 6790cab4cb8SJulian Andres Klode else 6800cab4cb8SJulian Andres Klode dev_err(nvec->dev, 681b77f2767SEbru Akagunduz "RX buffer overflow on %p: Trying to write byte %u of %u\n", 6826330f9cfSDan Carpenter nvec->rx, nvec->rx ? nvec->rx->pos : 0, 6836330f9cfSDan Carpenter NVEC_MSG_SIZE); 6840cab4cb8SJulian Andres Klode break; 6850cab4cb8SJulian Andres Klode default: 6860cab4cb8SJulian Andres Klode nvec->state = 0; 68732890b98SMarc Dietrich } 68832890b98SMarc Dietrich 6890cab4cb8SJulian Andres Klode /* If we are told that a new transfer starts, verify it */ 6900cab4cb8SJulian Andres Klode if ((status & (RCVD | RNW)) == RCVD) { 6910cab4cb8SJulian Andres Klode if (received != nvec->i2c_addr) 6920cab4cb8SJulian Andres Klode dev_err(nvec->dev, 6930cab4cb8SJulian Andres Klode "received address 0x%02x, expected 0x%02x\n", 6940cab4cb8SJulian Andres Klode received, nvec->i2c_addr); 6950cab4cb8SJulian Andres Klode nvec->state = 1; 69632890b98SMarc Dietrich } 6970cab4cb8SJulian Andres Klode 6980cab4cb8SJulian Andres Klode /* Send data if requested, but not on end of transmission */ 6990cab4cb8SJulian Andres Klode if ((status & (RNW | END_TRANS)) == RNW) 7000cab4cb8SJulian Andres Klode writel(to_send, nvec->base + I2C_SL_RCVD); 7010cab4cb8SJulian Andres Klode 7020cab4cb8SJulian Andres Klode /* If we have send the first byte */ 7030cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RNW | RCVD)) 7040cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 1); 7050cab4cb8SJulian Andres Klode 7060cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, 7070cab4cb8SJulian Andres Klode "Handled: %s 0x%02x, %s 0x%02x in state %u [%s%s%s]\n", 7080cab4cb8SJulian Andres Klode (status & RNW) == 0 ? "received" : "R=", 7090cab4cb8SJulian Andres Klode received, 7100cab4cb8SJulian Andres Klode (status & (RNW | END_TRANS)) ? "sent" : "S=", 7110cab4cb8SJulian Andres Klode to_send, 7120cab4cb8SJulian Andres Klode state, 7130cab4cb8SJulian Andres Klode status & END_TRANS ? " END_TRANS" : "", 7140cab4cb8SJulian Andres Klode status & RCVD ? " RCVD" : "", 7150cab4cb8SJulian Andres Klode status & RNW ? " RNW" : ""); 7160cab4cb8SJulian Andres Klode 717de839b8fSJulian Andres Klode 718de839b8fSJulian Andres Klode /* 719de839b8fSJulian Andres Klode * TODO: A correct fix needs to be found for this. 720de839b8fSJulian Andres Klode * 721de839b8fSJulian Andres Klode * We experience less incomplete messages with this delay than without 722de839b8fSJulian Andres Klode * it, but we don't know why. Help is appreciated. 723de839b8fSJulian Andres Klode */ 724de839b8fSJulian Andres Klode udelay(100); 725de839b8fSJulian Andres Klode 72632890b98SMarc Dietrich return IRQ_HANDLED; 72732890b98SMarc Dietrich } 72832890b98SMarc Dietrich 729f686e9afSMarc Dietrich static void tegra_init_i2c_slave(struct nvec_chip *nvec) 73032890b98SMarc Dietrich { 73132890b98SMarc Dietrich u32 val; 73232890b98SMarc Dietrich 73361c3b197SPrashant Gaikwad clk_prepare_enable(nvec->i2c_clk); 734f686e9afSMarc Dietrich 735c0df5bf5SStephen Warren reset_control_assert(nvec->rst); 73632890b98SMarc Dietrich udelay(2); 737c0df5bf5SStephen Warren reset_control_deassert(nvec->rst); 73832890b98SMarc Dietrich 73932890b98SMarc Dietrich val = I2C_CNFG_NEW_MASTER_SFM | I2C_CNFG_PACKET_MODE_EN | 74032890b98SMarc Dietrich (0x2 << I2C_CNFG_DEBOUNCE_CNT_SHIFT); 741f686e9afSMarc Dietrich writel(val, nvec->base + I2C_CNFG); 74232890b98SMarc Dietrich 743ac810759SMarc Dietrich clk_set_rate(nvec->i2c_clk, 8 * 80000); 744ac810759SMarc Dietrich 745d3f862aeSJulian Andres Klode writel(I2C_SL_NEWSL, nvec->base + I2C_SL_CNFG); 746ac810759SMarc Dietrich writel(0x1E, nvec->base + I2C_SL_DELAY_COUNT); 747ac810759SMarc Dietrich 748ac810759SMarc Dietrich writel(nvec->i2c_addr>>1, nvec->base + I2C_SL_ADDR1); 749ac810759SMarc Dietrich writel(0, nvec->base + I2C_SL_ADDR2); 750ac810759SMarc Dietrich 751ac810759SMarc Dietrich enable_irq(nvec->irq); 752ac810759SMarc Dietrich } 753ac810759SMarc Dietrich 754ebefae28SMarc Dietrich #ifdef CONFIG_PM_SLEEP 755ac810759SMarc Dietrich static void nvec_disable_i2c_slave(struct nvec_chip *nvec) 756ac810759SMarc Dietrich { 757ac810759SMarc Dietrich disable_irq(nvec->irq); 758d3f862aeSJulian Andres Klode writel(I2C_SL_NEWSL | I2C_SL_NACK, nvec->base + I2C_SL_CNFG); 75961c3b197SPrashant Gaikwad clk_disable_unprepare(nvec->i2c_clk); 76032890b98SMarc Dietrich } 761ebefae28SMarc Dietrich #endif 76232890b98SMarc Dietrich 76332890b98SMarc Dietrich static void nvec_power_off(void) 76432890b98SMarc Dietrich { 76593eff83fSMarc Dietrich char ap_pwr_down[] = { NVEC_SLEEP, AP_PWR_DOWN }; 76693eff83fSMarc Dietrich 767518945fbSMarc Dietrich nvec_toggle_global_events(nvec_power_handle, false); 76893eff83fSMarc Dietrich nvec_write_async(nvec_power_handle, ap_pwr_down, 2); 76932890b98SMarc Dietrich } 77032890b98SMarc Dietrich 77195cd1860SMarc Dietrich /* 77295cd1860SMarc Dietrich * Parse common device tree data 77395cd1860SMarc Dietrich */ 77495cd1860SMarc Dietrich static int nvec_i2c_parse_dt_pdata(struct nvec_chip *nvec) 77595cd1860SMarc Dietrich { 77695cd1860SMarc Dietrich nvec->gpio = of_get_named_gpio(nvec->dev->of_node, "request-gpios", 0); 77795cd1860SMarc Dietrich 77895cd1860SMarc Dietrich if (nvec->gpio < 0) { 77995cd1860SMarc Dietrich dev_err(nvec->dev, "no gpio specified"); 78095cd1860SMarc Dietrich return -ENODEV; 78195cd1860SMarc Dietrich } 78295cd1860SMarc Dietrich 78395cd1860SMarc Dietrich if (of_property_read_u32(nvec->dev->of_node, "slave-addr", 78495cd1860SMarc Dietrich &nvec->i2c_addr)) { 78595cd1860SMarc Dietrich dev_err(nvec->dev, "no i2c address specified"); 78695cd1860SMarc Dietrich return -ENODEV; 78795cd1860SMarc Dietrich } 78895cd1860SMarc Dietrich 78995cd1860SMarc Dietrich return 0; 79095cd1860SMarc Dietrich } 79195cd1860SMarc Dietrich 79246620803SBill Pemberton static int tegra_nvec_probe(struct platform_device *pdev) 79332890b98SMarc Dietrich { 794f686e9afSMarc Dietrich int err, ret; 79532890b98SMarc Dietrich struct clk *i2c_clk; 79632890b98SMarc Dietrich struct nvec_chip *nvec; 79732890b98SMarc Dietrich struct nvec_msg *msg; 798f686e9afSMarc Dietrich struct resource *res; 799f686e9afSMarc Dietrich void __iomem *base; 80093eff83fSMarc Dietrich char get_firmware_version[] = { NVEC_CNTL, GET_FIRMWARE_VERSION }, 80193eff83fSMarc Dietrich unmute_speakers[] = { NVEC_OEM0, 0x10, 0x59, 0x95 }, 80293eff83fSMarc Dietrich enable_event[7] = { NVEC_SYS, CNF_EVENT_REPORTING, true }; 80332890b98SMarc Dietrich 8042c6cbdd0SMarc Dietrich if (!pdev->dev.of_node) { 8052c6cbdd0SMarc Dietrich dev_err(&pdev->dev, "must be instantiated using device tree\n"); 8062c6cbdd0SMarc Dietrich return -ENODEV; 8072c6cbdd0SMarc Dietrich } 8082c6cbdd0SMarc Dietrich 809f5e3352eSMarc Dietrich nvec = devm_kzalloc(&pdev->dev, sizeof(struct nvec_chip), GFP_KERNEL); 81032890b98SMarc Dietrich if (nvec == NULL) { 81132890b98SMarc Dietrich dev_err(&pdev->dev, "failed to reserve memory\n"); 81232890b98SMarc Dietrich return -ENOMEM; 81332890b98SMarc Dietrich } 81432890b98SMarc Dietrich platform_set_drvdata(pdev, nvec); 81532890b98SMarc Dietrich nvec->dev = &pdev->dev; 8167990b0d7SMarc Dietrich 81795cd1860SMarc Dietrich err = nvec_i2c_parse_dt_pdata(nvec); 81895cd1860SMarc Dietrich if (err < 0) 81995cd1860SMarc Dietrich return err; 82032890b98SMarc Dietrich 821f686e9afSMarc Dietrich res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 82297f4be60SThierry Reding base = devm_ioremap_resource(&pdev->dev, res); 82397f4be60SThierry Reding if (IS_ERR(base)) 82497f4be60SThierry Reding return PTR_ERR(base); 82532890b98SMarc Dietrich 826f686e9afSMarc Dietrich res = platform_get_resource(pdev, IORESOURCE_IRQ, 0); 827f686e9afSMarc Dietrich if (!res) { 828f686e9afSMarc Dietrich dev_err(&pdev->dev, "no irq resource?\n"); 829f5e3352eSMarc Dietrich return -ENODEV; 830f686e9afSMarc Dietrich } 831f686e9afSMarc Dietrich 832c2b62f60SMarc Dietrich i2c_clk = devm_clk_get(&pdev->dev, "div-clk"); 833f686e9afSMarc Dietrich if (IS_ERR(i2c_clk)) { 834f686e9afSMarc Dietrich dev_err(nvec->dev, "failed to get controller clock\n"); 835f5e3352eSMarc Dietrich return -ENODEV; 83632890b98SMarc Dietrich } 83732890b98SMarc Dietrich 838c0df5bf5SStephen Warren nvec->rst = devm_reset_control_get(&pdev->dev, "i2c"); 839c0df5bf5SStephen Warren if (IS_ERR(nvec->rst)) { 840c0df5bf5SStephen Warren dev_err(nvec->dev, "failed to get controller reset\n"); 841c0df5bf5SStephen Warren return PTR_ERR(nvec->rst); 842c0df5bf5SStephen Warren } 843c0df5bf5SStephen Warren 844f686e9afSMarc Dietrich nvec->base = base; 845f686e9afSMarc Dietrich nvec->irq = res->start; 846f686e9afSMarc Dietrich nvec->i2c_clk = i2c_clk; 8470cab4cb8SJulian Andres Klode nvec->rx = &nvec->msg_pool[0]; 848f686e9afSMarc Dietrich 84932890b98SMarc Dietrich ATOMIC_INIT_NOTIFIER_HEAD(&nvec->notifier_list); 85032890b98SMarc Dietrich 85132890b98SMarc Dietrich init_completion(&nvec->sync_write); 8520cab4cb8SJulian Andres Klode init_completion(&nvec->ec_transfer); 8530cab4cb8SJulian Andres Klode mutex_init(&nvec->sync_write_mutex); 8540cab4cb8SJulian Andres Klode spin_lock_init(&nvec->tx_lock); 8550cab4cb8SJulian Andres Klode spin_lock_init(&nvec->rx_lock); 85632890b98SMarc Dietrich INIT_LIST_HEAD(&nvec->rx_data); 8570cab4cb8SJulian Andres Klode INIT_LIST_HEAD(&nvec->tx_data); 85832890b98SMarc Dietrich INIT_WORK(&nvec->rx_work, nvec_dispatch); 85932890b98SMarc Dietrich INIT_WORK(&nvec->tx_work, nvec_request_master); 86032890b98SMarc Dietrich 861f5e3352eSMarc Dietrich err = devm_gpio_request_one(&pdev->dev, nvec->gpio, GPIOF_OUT_INIT_HIGH, 862f5e3352eSMarc Dietrich "nvec gpio"); 863aed92bbcSJulian Andres Klode if (err < 0) { 864aed92bbcSJulian Andres Klode dev_err(nvec->dev, "couldn't request gpio\n"); 865f5e3352eSMarc Dietrich return -ENODEV; 866aed92bbcSJulian Andres Klode } 867aed92bbcSJulian Andres Klode 868f5e3352eSMarc Dietrich err = devm_request_irq(&pdev->dev, nvec->irq, nvec_interrupt, 0, 869f5e3352eSMarc Dietrich "nvec", nvec); 870f686e9afSMarc Dietrich if (err) { 871f686e9afSMarc Dietrich dev_err(nvec->dev, "couldn't request irq\n"); 872f5e3352eSMarc Dietrich return -ENODEV; 873f686e9afSMarc Dietrich } 874ac810759SMarc Dietrich disable_irq(nvec->irq); 875f686e9afSMarc Dietrich 876f686e9afSMarc Dietrich tegra_init_i2c_slave(nvec); 877f686e9afSMarc Dietrich 87832890b98SMarc Dietrich /* enable event reporting */ 879518945fbSMarc Dietrich nvec_toggle_global_events(nvec, true); 88032890b98SMarc Dietrich 88132890b98SMarc Dietrich nvec->nvec_status_notifier.notifier_call = nvec_status_notifier; 88232890b98SMarc Dietrich nvec_register_notifier(nvec, &nvec->nvec_status_notifier, 0); 88332890b98SMarc Dietrich 88432890b98SMarc Dietrich nvec_power_handle = nvec; 88532890b98SMarc Dietrich pm_power_off = nvec_power_off; 88632890b98SMarc Dietrich 88732890b98SMarc Dietrich /* Get Firmware Version */ 88893eff83fSMarc Dietrich msg = nvec_write_sync(nvec, get_firmware_version, 2); 88932890b98SMarc Dietrich 8900cab4cb8SJulian Andres Klode if (msg) { 89132890b98SMarc Dietrich dev_warn(nvec->dev, "ec firmware version %02x.%02x.%02x / %02x\n", 89232890b98SMarc Dietrich msg->data[4], msg->data[5], msg->data[6], msg->data[7]); 89332890b98SMarc Dietrich 8940cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg); 8950cab4cb8SJulian Andres Klode } 89632890b98SMarc Dietrich 897f686e9afSMarc Dietrich ret = mfd_add_devices(nvec->dev, -1, nvec_devices, 8980848c94fSMark Brown ARRAY_SIZE(nvec_devices), base, 0, NULL); 899f686e9afSMarc Dietrich if (ret) 900f686e9afSMarc Dietrich dev_err(nvec->dev, "error adding subdevices\n"); 901f686e9afSMarc Dietrich 90232890b98SMarc Dietrich /* unmute speakers? */ 90393eff83fSMarc Dietrich nvec_write_async(nvec, unmute_speakers, 4); 90432890b98SMarc Dietrich 90532890b98SMarc Dietrich /* enable lid switch event */ 90693eff83fSMarc Dietrich nvec_event_mask(enable_event, LID_SWITCH); 90793eff83fSMarc Dietrich nvec_write_async(nvec, enable_event, 7); 90832890b98SMarc Dietrich 90932890b98SMarc Dietrich /* enable power button event */ 91093eff83fSMarc Dietrich nvec_event_mask(enable_event, PWR_BUTTON); 91193eff83fSMarc Dietrich nvec_write_async(nvec, enable_event, 7); 91232890b98SMarc Dietrich 91332890b98SMarc Dietrich return 0; 91432890b98SMarc Dietrich } 91532890b98SMarc Dietrich 9161a6a8a84SBill Pemberton static int tegra_nvec_remove(struct platform_device *pdev) 91732890b98SMarc Dietrich { 918f686e9afSMarc Dietrich struct nvec_chip *nvec = platform_get_drvdata(pdev); 919f686e9afSMarc Dietrich 920518945fbSMarc Dietrich nvec_toggle_global_events(nvec, false); 921f686e9afSMarc Dietrich mfd_remove_devices(nvec->dev); 922c2b62f60SMarc Dietrich nvec_unregister_notifier(nvec, &nvec->nvec_status_notifier); 923eb1e40a4STejun Heo cancel_work_sync(&nvec->rx_work); 924eb1e40a4STejun Heo cancel_work_sync(&nvec->tx_work); 925c2b62f60SMarc Dietrich /* FIXME: needs check wether nvec is responsible for power off */ 926c2b62f60SMarc Dietrich pm_power_off = NULL; 927f686e9afSMarc Dietrich 92832890b98SMarc Dietrich return 0; 92932890b98SMarc Dietrich } 93032890b98SMarc Dietrich 931ebefae28SMarc Dietrich #ifdef CONFIG_PM_SLEEP 932ebefae28SMarc Dietrich static int nvec_suspend(struct device *dev) 93332890b98SMarc Dietrich { 934ebefae28SMarc Dietrich struct platform_device *pdev = to_platform_device(dev); 93532890b98SMarc Dietrich struct nvec_chip *nvec = platform_get_drvdata(pdev); 9369feeb014SMarc Dietrich struct nvec_msg *msg; 93793eff83fSMarc Dietrich char ap_suspend[] = { NVEC_SLEEP, AP_SUSPEND }; 93832890b98SMarc Dietrich 93932890b98SMarc Dietrich dev_dbg(nvec->dev, "suspending\n"); 9409feeb014SMarc Dietrich 9419feeb014SMarc Dietrich /* keep these sync or you'll break suspend */ 94293eff83fSMarc Dietrich nvec_toggle_global_events(nvec, false); 94393eff83fSMarc Dietrich 94493eff83fSMarc Dietrich msg = nvec_write_sync(nvec, ap_suspend, sizeof(ap_suspend)); 9459feeb014SMarc Dietrich nvec_msg_free(nvec, msg); 9469feeb014SMarc Dietrich 947ac810759SMarc Dietrich nvec_disable_i2c_slave(nvec); 94832890b98SMarc Dietrich 94932890b98SMarc Dietrich return 0; 95032890b98SMarc Dietrich } 95132890b98SMarc Dietrich 952ebefae28SMarc Dietrich static int nvec_resume(struct device *dev) 953162c7d8cSMarc Dietrich { 954ebefae28SMarc Dietrich struct platform_device *pdev = to_platform_device(dev); 95532890b98SMarc Dietrich struct nvec_chip *nvec = platform_get_drvdata(pdev); 95632890b98SMarc Dietrich 95732890b98SMarc Dietrich dev_dbg(nvec->dev, "resuming\n"); 958f686e9afSMarc Dietrich tegra_init_i2c_slave(nvec); 959518945fbSMarc Dietrich nvec_toggle_global_events(nvec, true); 96032890b98SMarc Dietrich 96132890b98SMarc Dietrich return 0; 96232890b98SMarc Dietrich } 96332890b98SMarc Dietrich #endif 96432890b98SMarc Dietrich 965ebefae28SMarc Dietrich static const SIMPLE_DEV_PM_OPS(nvec_pm_ops, nvec_suspend, nvec_resume); 966ebefae28SMarc Dietrich 9677990b0d7SMarc Dietrich /* Match table for of_platform binding */ 968063f9f6aSBill Pemberton static const struct of_device_id nvidia_nvec_of_match[] = { 9697990b0d7SMarc Dietrich { .compatible = "nvidia,nvec", }, 9707990b0d7SMarc Dietrich {}, 9717990b0d7SMarc Dietrich }; 9727990b0d7SMarc Dietrich MODULE_DEVICE_TABLE(of, nvidia_nvec_of_match); 9737990b0d7SMarc Dietrich 974162c7d8cSMarc Dietrich static struct platform_driver nvec_device_driver = { 97532890b98SMarc Dietrich .probe = tegra_nvec_probe, 97644b90a3fSBill Pemberton .remove = tegra_nvec_remove, 97732890b98SMarc Dietrich .driver = { 97832890b98SMarc Dietrich .name = "nvec", 97932890b98SMarc Dietrich .owner = THIS_MODULE, 980ebefae28SMarc Dietrich .pm = &nvec_pm_ops, 9817990b0d7SMarc Dietrich .of_match_table = nvidia_nvec_of_match, 98232890b98SMarc Dietrich } 98332890b98SMarc Dietrich }; 98432890b98SMarc Dietrich 9859891b1ceSMarc Dietrich module_platform_driver(nvec_device_driver); 986162c7d8cSMarc Dietrich 98732890b98SMarc Dietrich MODULE_ALIAS("platform:nvec"); 988162c7d8cSMarc Dietrich MODULE_DESCRIPTION("NVIDIA compliant embedded controller interface"); 989162c7d8cSMarc Dietrich MODULE_AUTHOR("Marc Dietrich <marvin24@gmx.de>"); 990162c7d8cSMarc Dietrich MODULE_LICENSE("GPL"); 991