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 1712b5a55dSJulian Andres Klode #include <linux/kernel.h> 183b769eddSMarc Dietrich #include <linux/module.h> 190b1076c4SJulian Andres Klode #include <linux/atomic.h> 2012b5a55dSJulian Andres Klode #include <linux/clk.h> 2132890b98SMarc Dietrich #include <linux/completion.h> 2212b5a55dSJulian Andres Klode #include <linux/delay.h> 2312b5a55dSJulian Andres Klode #include <linux/err.h> 2412b5a55dSJulian Andres Klode #include <linux/gpio.h> 2532890b98SMarc Dietrich #include <linux/interrupt.h> 26162c7d8cSMarc Dietrich #include <linux/io.h> 2732890b98SMarc Dietrich #include <linux/irq.h> 287990b0d7SMarc Dietrich #include <linux/of.h> 297990b0d7SMarc Dietrich #include <linux/of_gpio.h> 3032890b98SMarc Dietrich #include <linux/list.h> 3112b5a55dSJulian Andres Klode #include <linux/mfd/core.h> 3212b5a55dSJulian Andres Klode #include <linux/mutex.h> 3332890b98SMarc Dietrich #include <linux/notifier.h> 3412b5a55dSJulian Andres Klode #include <linux/slab.h> 3512b5a55dSJulian Andres Klode #include <linux/spinlock.h> 3612b5a55dSJulian Andres Klode #include <linux/workqueue.h> 37162c7d8cSMarc Dietrich 3832890b98SMarc Dietrich #include "nvec.h" 3932890b98SMarc Dietrich 40391d2fa9SJulian Andres Klode #define I2C_CNFG 0x00 41d09c2a84SLaura Garcia Liebana #define I2C_CNFG_PACKET_MODE_EN BIT(10) 42d09c2a84SLaura Garcia Liebana #define I2C_CNFG_NEW_MASTER_SFM BIT(11) 43391d2fa9SJulian Andres Klode #define I2C_CNFG_DEBOUNCE_CNT_SHIFT 12 44391d2fa9SJulian Andres Klode 45391d2fa9SJulian Andres Klode #define I2C_SL_CNFG 0x20 46d09c2a84SLaura Garcia Liebana #define I2C_SL_NEWSL BIT(2) 47d09c2a84SLaura Garcia Liebana #define I2C_SL_NACK BIT(1) 48d09c2a84SLaura Garcia Liebana #define I2C_SL_RESP BIT(0) 49d09c2a84SLaura Garcia Liebana #define I2C_SL_IRQ BIT(3) 50d09c2a84SLaura Garcia Liebana #define END_TRANS BIT(4) 51d09c2a84SLaura Garcia Liebana #define RCVD BIT(2) 52d09c2a84SLaura Garcia Liebana #define RNW BIT(1) 53391d2fa9SJulian Andres Klode 54391d2fa9SJulian Andres Klode #define I2C_SL_RCVD 0x24 55391d2fa9SJulian Andres Klode #define I2C_SL_STATUS 0x28 56391d2fa9SJulian Andres Klode #define I2C_SL_ADDR1 0x2c 57391d2fa9SJulian Andres Klode #define I2C_SL_ADDR2 0x30 58391d2fa9SJulian Andres Klode #define I2C_SL_DELAY_COUNT 0x3c 59391d2fa9SJulian Andres Klode 60bb0590e2SJulian Andres Klode /** 61bb0590e2SJulian Andres Klode * enum nvec_msg_category - Message categories for nvec_msg_alloc() 62bb0590e2SJulian Andres Klode * @NVEC_MSG_RX: The message is an incoming message (from EC) 63bb0590e2SJulian Andres Klode * @NVEC_MSG_TX: The message is an outgoing message (to EC) 64bb0590e2SJulian Andres Klode */ 65bb0590e2SJulian Andres Klode enum nvec_msg_category { 66bb0590e2SJulian Andres Klode NVEC_MSG_RX, 67bb0590e2SJulian Andres Klode NVEC_MSG_TX, 68bb0590e2SJulian Andres Klode }; 69bb0590e2SJulian Andres Klode 70518945fbSMarc Dietrich enum nvec_sleep_subcmds { 71518945fbSMarc Dietrich GLOBAL_EVENTS, 7293eff83fSMarc Dietrich AP_PWR_DOWN, 7393eff83fSMarc Dietrich AP_SUSPEND, 74518945fbSMarc Dietrich }; 75518945fbSMarc Dietrich 7693eff83fSMarc Dietrich #define CNF_EVENT_REPORTING 0x01 7793eff83fSMarc Dietrich #define GET_FIRMWARE_VERSION 0x15 7893eff83fSMarc Dietrich #define LID_SWITCH BIT(1) 7993eff83fSMarc Dietrich #define PWR_BUTTON BIT(15) 8032890b98SMarc Dietrich 8132890b98SMarc Dietrich static struct nvec_chip *nvec_power_handle; 8232890b98SMarc Dietrich 8328397dc9SGeert Uytterhoeven static const struct mfd_cell nvec_devices[] = { 84f686e9afSMarc Dietrich { 85f686e9afSMarc Dietrich .name = "nvec-kbd", 86f686e9afSMarc Dietrich }, 87f686e9afSMarc Dietrich { 88f686e9afSMarc Dietrich .name = "nvec-mouse", 893ec69881SMarc Dietrich }, 903ec69881SMarc Dietrich { 913ec69881SMarc Dietrich .name = "nvec-power", 923ec69881SMarc Dietrich .id = 0, 93f686e9afSMarc Dietrich }, 94f686e9afSMarc Dietrich { 95f686e9afSMarc Dietrich .name = "nvec-power", 96f686e9afSMarc Dietrich .id = 1, 97f686e9afSMarc Dietrich }, 98f686e9afSMarc Dietrich { 99ac562680SMarc Dietrich .name = "nvec-paz00", 10097cc2657SIlya Petrov }, 101f686e9afSMarc Dietrich }; 102f686e9afSMarc Dietrich 103bdf034d9SJulian Andres Klode /** 104bdf034d9SJulian Andres Klode * nvec_register_notifier - Register a notifier with nvec 105bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 106bdf034d9SJulian Andres Klode * @nb: The notifier block to register 107bdf034d9SJulian Andres Klode * 108bdf034d9SJulian Andres Klode * Registers a notifier with @nvec. The notifier will be added to an atomic 109bdf034d9SJulian Andres Klode * notifier chain that is called for all received messages except those that 110bdf034d9SJulian Andres Klode * correspond to a request initiated by nvec_write_sync(). 111bdf034d9SJulian Andres Klode */ 11232890b98SMarc Dietrich int nvec_register_notifier(struct nvec_chip *nvec, struct notifier_block *nb, 11332890b98SMarc Dietrich unsigned int events) 11432890b98SMarc Dietrich { 11532890b98SMarc Dietrich return atomic_notifier_chain_register(&nvec->notifier_list, nb); 11632890b98SMarc Dietrich } 11732890b98SMarc Dietrich EXPORT_SYMBOL_GPL(nvec_register_notifier); 11832890b98SMarc Dietrich 119bdf034d9SJulian Andres Klode /** 120111c1587SMarc Dietrich * nvec_unregister_notifier - Unregister a notifier with nvec 121111c1587SMarc Dietrich * @nvec: A &struct nvec_chip 122111c1587SMarc Dietrich * @nb: The notifier block to unregister 123111c1587SMarc Dietrich * 124111c1587SMarc Dietrich * Unregisters a notifier with @nvec. The notifier will be removed from the 125111c1587SMarc Dietrich * atomic notifier chain. 126111c1587SMarc Dietrich */ 127111c1587SMarc Dietrich int nvec_unregister_notifier(struct nvec_chip *nvec, struct notifier_block *nb) 128111c1587SMarc Dietrich { 129111c1587SMarc Dietrich return atomic_notifier_chain_unregister(&nvec->notifier_list, nb); 130111c1587SMarc Dietrich } 131111c1587SMarc Dietrich EXPORT_SYMBOL_GPL(nvec_unregister_notifier); 132111c1587SMarc Dietrich 133111c1587SMarc Dietrich /** 134bdf034d9SJulian Andres Klode * nvec_status_notifier - The final notifier 135bdf034d9SJulian Andres Klode * 136bdf034d9SJulian Andres Klode * Prints a message about control events not handled in the notifier 137bdf034d9SJulian Andres Klode * chain. 138bdf034d9SJulian Andres Klode */ 139162c7d8cSMarc Dietrich static int nvec_status_notifier(struct notifier_block *nb, 140162c7d8cSMarc Dietrich unsigned long event_type, void *data) 14132890b98SMarc Dietrich { 14250d4656aSMarc Dietrich struct nvec_chip *nvec = container_of(nb, struct nvec_chip, 14350d4656aSMarc Dietrich nvec_status_notifier); 14432890b98SMarc Dietrich unsigned char *msg = (unsigned char *)data; 14532890b98SMarc Dietrich 14632890b98SMarc Dietrich if (event_type != NVEC_CNTL) 14732890b98SMarc Dietrich return NOTIFY_DONE; 14832890b98SMarc Dietrich 14950d4656aSMarc Dietrich dev_warn(nvec->dev, "unhandled msg type %ld\n", event_type); 150a3a9aa1aSMarc Dietrich print_hex_dump(KERN_WARNING, "payload: ", DUMP_PREFIX_NONE, 16, 1, 151a3a9aa1aSMarc Dietrich msg, msg[1] + 2, true); 15232890b98SMarc Dietrich 15332890b98SMarc Dietrich return NOTIFY_OK; 15432890b98SMarc Dietrich } 15532890b98SMarc Dietrich 156bdf034d9SJulian Andres Klode /** 157bdf034d9SJulian Andres Klode * nvec_msg_alloc: 158bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 159bb0590e2SJulian Andres Klode * @category: Pool category, see &enum nvec_msg_category 160bdf034d9SJulian Andres Klode * 161bdf034d9SJulian Andres Klode * Allocate a single &struct nvec_msg object from the message pool of 162bdf034d9SJulian Andres Klode * @nvec. The result shall be passed to nvec_msg_free() if no longer 163bdf034d9SJulian Andres Klode * used. 164bb0590e2SJulian Andres Klode * 165bb0590e2SJulian Andres Klode * Outgoing messages are placed in the upper 75% of the pool, keeping the 166bb0590e2SJulian Andres Klode * lower 25% available for RX buffers only. The reason is to prevent a 167bb0590e2SJulian Andres Klode * situation where all buffers are full and a message is thus endlessly 168bb0590e2SJulian Andres Klode * retried because the response could never be processed. 169bdf034d9SJulian Andres Klode */ 170bb0590e2SJulian Andres Klode static struct nvec_msg *nvec_msg_alloc(struct nvec_chip *nvec, 171bb0590e2SJulian Andres Klode enum nvec_msg_category category) 1720b1076c4SJulian Andres Klode { 173bb0590e2SJulian Andres Klode int i = (category == NVEC_MSG_TX) ? (NVEC_POOL_SIZE / 4) : 0; 1740b1076c4SJulian Andres Klode 175bb0590e2SJulian Andres Klode for (; i < NVEC_POOL_SIZE; i++) { 1760b1076c4SJulian Andres Klode if (atomic_xchg(&nvec->msg_pool[i].used, 1) == 0) { 1770b1076c4SJulian Andres Klode dev_vdbg(nvec->dev, "INFO: Allocate %i\n", i); 1780b1076c4SJulian Andres Klode return &nvec->msg_pool[i]; 1790b1076c4SJulian Andres Klode } 1800b1076c4SJulian Andres Klode } 1810b1076c4SJulian Andres Klode 182bb0590e2SJulian Andres Klode dev_err(nvec->dev, "could not allocate %s buffer\n", 183bb0590e2SJulian Andres Klode (category == NVEC_MSG_TX) ? "TX" : "RX"); 1840b1076c4SJulian Andres Klode 1850b1076c4SJulian Andres Klode return NULL; 1860b1076c4SJulian Andres Klode } 1870b1076c4SJulian Andres Klode 188bdf034d9SJulian Andres Klode /** 189bdf034d9SJulian Andres Klode * nvec_msg_free: 190bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 191bdf034d9SJulian Andres Klode * @msg: A message (must be allocated by nvec_msg_alloc() and belong to @nvec) 192bdf034d9SJulian Andres Klode * 193bdf034d9SJulian Andres Klode * Free the given message 194bdf034d9SJulian Andres Klode */ 195705a4212SDenis Efremov void nvec_msg_free(struct nvec_chip *nvec, struct nvec_msg *msg) 1960b1076c4SJulian Andres Klode { 1977b770657SJulian Andres Klode if (msg != &nvec->tx_scratch) 1980b1076c4SJulian Andres Klode dev_vdbg(nvec->dev, "INFO: Free %ti\n", msg - nvec->msg_pool); 1990b1076c4SJulian Andres Klode atomic_set(&msg->used, 0); 2000b1076c4SJulian Andres Klode } 201198dd267SJulian Andres Klode EXPORT_SYMBOL_GPL(nvec_msg_free); 2020b1076c4SJulian Andres Klode 2038517e879SJulian Andres Klode /** 2048517e879SJulian Andres Klode * nvec_msg_is_event - Return %true if @msg is an event 2058517e879SJulian Andres Klode * @msg: A message 2068517e879SJulian Andres Klode */ 2078517e879SJulian Andres Klode static bool nvec_msg_is_event(struct nvec_msg *msg) 2088517e879SJulian Andres Klode { 2098517e879SJulian Andres Klode return msg->data[0] >> 7; 2108517e879SJulian Andres Klode } 2118517e879SJulian Andres Klode 2128517e879SJulian Andres Klode /** 2138517e879SJulian Andres Klode * nvec_msg_size - Get the size of a message 2148517e879SJulian Andres Klode * @msg: The message to get the size for 2158517e879SJulian Andres Klode * 2168517e879SJulian Andres Klode * This only works for received messages, not for outgoing messages. 2178517e879SJulian Andres Klode */ 2188517e879SJulian Andres Klode static size_t nvec_msg_size(struct nvec_msg *msg) 2198517e879SJulian Andres Klode { 2208517e879SJulian Andres Klode bool is_event = nvec_msg_is_event(msg); 2218517e879SJulian Andres Klode int event_length = (msg->data[0] & 0x60) >> 5; 2228517e879SJulian Andres Klode 2238517e879SJulian Andres Klode /* for variable size, payload size in byte 1 + count (1) + cmd (1) */ 2248517e879SJulian Andres Klode if (!is_event || event_length == NVEC_VAR_SIZE) 2258517e879SJulian Andres Klode return (msg->pos || msg->size) ? (msg->data[1] + 2) : 0; 2268517e879SJulian Andres Klode else if (event_length == NVEC_2BYTES) 2278517e879SJulian Andres Klode return 2; 2288517e879SJulian Andres Klode else if (event_length == NVEC_3BYTES) 2298517e879SJulian Andres Klode return 3; 2308517e879SJulian Andres Klode return 0; 2318517e879SJulian Andres Klode } 2328517e879SJulian Andres Klode 233bdf034d9SJulian Andres Klode /** 234bdf034d9SJulian Andres Klode * nvec_gpio_set_value - Set the GPIO value 235bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 236bdf034d9SJulian Andres Klode * @value: The value to write (0 or 1) 237bdf034d9SJulian Andres Klode * 238bdf034d9SJulian Andres Klode * Like gpio_set_value(), but generating debugging information 239bdf034d9SJulian Andres Klode */ 240e7c40851SJulian Andres Klode static void nvec_gpio_set_value(struct nvec_chip *nvec, int value) 241e7c40851SJulian Andres Klode { 242e7c40851SJulian Andres Klode dev_dbg(nvec->dev, "GPIO changed from %u to %u\n", 243e7c40851SJulian Andres Klode gpio_get_value(nvec->gpio), value); 244e7c40851SJulian Andres Klode gpio_set_value(nvec->gpio, value); 245e7c40851SJulian Andres Klode } 246e7c40851SJulian Andres Klode 247bdf034d9SJulian Andres Klode /** 248bdf034d9SJulian Andres Klode * nvec_write_async - Asynchronously write a message to NVEC 249bdf034d9SJulian Andres Klode * @nvec: An nvec_chip instance 250bdf034d9SJulian Andres Klode * @data: The message data, starting with the request type 251bdf034d9SJulian Andres Klode * @size: The size of @data 252bdf034d9SJulian Andres Klode * 253bdf034d9SJulian Andres Klode * Queue a single message to be transferred to the embedded controller 254bdf034d9SJulian Andres Klode * and return immediately. 255bdf034d9SJulian Andres Klode * 256bdf034d9SJulian Andres Klode * Returns: 0 on success, a negative error code on failure. If a failure 2579b872a74SGustavo A. R. Silva * occurred, the nvec driver may print an error. 258bdf034d9SJulian Andres Klode */ 2591b9bf629SJulian Andres Klode int nvec_write_async(struct nvec_chip *nvec, const unsigned char *data, 260162c7d8cSMarc Dietrich short size) 26132890b98SMarc Dietrich { 2620cab4cb8SJulian Andres Klode struct nvec_msg *msg; 2630cab4cb8SJulian Andres Klode unsigned long flags; 26432890b98SMarc Dietrich 265bb0590e2SJulian Andres Klode msg = nvec_msg_alloc(nvec, NVEC_MSG_TX); 266bb0590e2SJulian Andres Klode 2671b9bf629SJulian Andres Klode if (msg == NULL) 2681b9bf629SJulian Andres Klode return -ENOMEM; 2691b9bf629SJulian Andres Klode 27032890b98SMarc Dietrich msg->data[0] = size; 27132890b98SMarc Dietrich memcpy(msg->data + 1, data, size); 27232890b98SMarc Dietrich msg->size = size + 1; 27332890b98SMarc Dietrich 2740cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags); 27532890b98SMarc Dietrich list_add_tail(&msg->node, &nvec->tx_data); 2760cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags); 27732890b98SMarc Dietrich 278033d9959SLinus Torvalds schedule_work(&nvec->tx_work); 2791b9bf629SJulian Andres Klode 2801b9bf629SJulian Andres Klode return 0; 28132890b98SMarc Dietrich } 28232890b98SMarc Dietrich EXPORT_SYMBOL(nvec_write_async); 28332890b98SMarc Dietrich 284bdf034d9SJulian Andres Klode /** 285bdf034d9SJulian Andres Klode * nvec_write_sync - Write a message to nvec and read the response 286bdf034d9SJulian Andres Klode * @nvec: An &struct nvec_chip 287bdf034d9SJulian Andres Klode * @data: The data to write 288bdf034d9SJulian Andres Klode * @size: The size of @data 28973b37c91STomás Tormo * @msg: The response message received 290bdf034d9SJulian Andres Klode * 291bdf034d9SJulian Andres Klode * This is similar to nvec_write_async(), but waits for the 292bdf034d9SJulian Andres Klode * request to be answered before returning. This function 293bdf034d9SJulian Andres Klode * uses a mutex and can thus not be called from e.g. 294bdf034d9SJulian Andres Klode * interrupt handlers. 295bdf034d9SJulian Andres Klode * 29673b37c91STomás Tormo * Returns: 0 on success, a negative error code on failure. 29773b37c91STomás Tormo * The response message is returned in @msg. Shall be freed with 29873b37c91STomás Tormo * with nvec_msg_free() once no longer used. 29973b37c91STomás Tormo * 300bdf034d9SJulian Andres Klode */ 30173b37c91STomás Tormo int nvec_write_sync(struct nvec_chip *nvec, 30273b37c91STomás Tormo const unsigned char *data, short size, 30373b37c91STomás Tormo struct nvec_msg **msg) 3040cab4cb8SJulian Andres Klode { 3050cab4cb8SJulian Andres Klode mutex_lock(&nvec->sync_write_mutex); 3060cab4cb8SJulian Andres Klode 30773b37c91STomás Tormo *msg = NULL; 3080cab4cb8SJulian Andres Klode nvec->sync_write_pending = (data[1] << 8) + data[0]; 3091b9bf629SJulian Andres Klode 3104b8bf03dSMarc Dietrich if (nvec_write_async(nvec, data, size) < 0) { 3114b8bf03dSMarc Dietrich mutex_unlock(&nvec->sync_write_mutex); 31273b37c91STomás Tormo return -ENOMEM; 3134b8bf03dSMarc Dietrich } 3140cab4cb8SJulian Andres Klode 3150cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "nvec_sync_write: 0x%04x\n", 3160cab4cb8SJulian Andres Klode nvec->sync_write_pending); 3170cab4cb8SJulian Andres Klode if (!(wait_for_completion_timeout(&nvec->sync_write, 3180cab4cb8SJulian Andres Klode msecs_to_jiffies(2000)))) { 319a4fe05d5SLaura Garcia Liebana dev_warn(nvec->dev, 320a4fe05d5SLaura Garcia Liebana "timeout waiting for sync write to complete\n"); 3210cab4cb8SJulian Andres Klode mutex_unlock(&nvec->sync_write_mutex); 32273b37c91STomás Tormo return -ETIMEDOUT; 3230cab4cb8SJulian Andres Klode } 3240cab4cb8SJulian Andres Klode 3250cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "nvec_sync_write: pong!\n"); 3260cab4cb8SJulian Andres Klode 32773b37c91STomás Tormo *msg = nvec->last_sync_msg; 3280cab4cb8SJulian Andres Klode 3290cab4cb8SJulian Andres Klode mutex_unlock(&nvec->sync_write_mutex); 3300cab4cb8SJulian Andres Klode 33173b37c91STomás Tormo return 0; 3320cab4cb8SJulian Andres Klode } 3330cab4cb8SJulian Andres Klode EXPORT_SYMBOL(nvec_write_sync); 3340cab4cb8SJulian Andres Klode 335bdf034d9SJulian Andres Klode /** 336518945fbSMarc Dietrich * nvec_toggle_global_events - enables or disables global event reporting 337518945fbSMarc Dietrich * @nvec: nvec handle 338518945fbSMarc Dietrich * @state: true for enable, false for disable 339518945fbSMarc Dietrich * 340518945fbSMarc Dietrich * This switches on/off global event reports by the embedded controller. 341518945fbSMarc Dietrich */ 342518945fbSMarc Dietrich static void nvec_toggle_global_events(struct nvec_chip *nvec, bool state) 343518945fbSMarc Dietrich { 344518945fbSMarc Dietrich unsigned char global_events[] = { NVEC_SLEEP, GLOBAL_EVENTS, state }; 345518945fbSMarc Dietrich 346518945fbSMarc Dietrich nvec_write_async(nvec, global_events, 3); 347518945fbSMarc Dietrich } 348518945fbSMarc Dietrich 349518945fbSMarc Dietrich /** 35093eff83fSMarc Dietrich * nvec_event_mask - fill the command string with event bitfield 35193eff83fSMarc Dietrich * ev: points to event command string 35293eff83fSMarc Dietrich * mask: bit to insert into the event mask 35393eff83fSMarc Dietrich * 35493eff83fSMarc Dietrich * Configure event command expects a 32 bit bitfield which describes 35593eff83fSMarc Dietrich * which events to enable. The bitfield has the following structure 35693eff83fSMarc Dietrich * (from highest byte to lowest): 35793eff83fSMarc Dietrich * system state bits 7-0 35893eff83fSMarc Dietrich * system state bits 15-8 35993eff83fSMarc Dietrich * oem system state bits 7-0 36093eff83fSMarc Dietrich * oem system state bits 15-8 36193eff83fSMarc Dietrich */ 36293eff83fSMarc Dietrich static void nvec_event_mask(char *ev, u32 mask) 36393eff83fSMarc Dietrich { 364815fb010SWei Yongjun ev[3] = mask >> 16 & 0xff; 365815fb010SWei Yongjun ev[4] = mask >> 24 & 0xff; 366815fb010SWei Yongjun ev[5] = mask >> 0 & 0xff; 367815fb010SWei Yongjun ev[6] = mask >> 8 & 0xff; 36893eff83fSMarc Dietrich } 36993eff83fSMarc Dietrich 37093eff83fSMarc Dietrich /** 371bdf034d9SJulian Andres Klode * nvec_request_master - Process outgoing messages 372bdf034d9SJulian Andres Klode * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip) 373bdf034d9SJulian Andres Klode * 374bdf034d9SJulian Andres Klode * Processes all outgoing requests by sending the request and awaiting the 375bdf034d9SJulian Andres Klode * response, then continuing with the next request. Once a request has a 376bdf034d9SJulian Andres Klode * matching response, it will be freed and removed from the list. 377bdf034d9SJulian Andres Klode */ 37832890b98SMarc Dietrich static void nvec_request_master(struct work_struct *work) 37932890b98SMarc Dietrich { 38032890b98SMarc Dietrich struct nvec_chip *nvec = container_of(work, struct nvec_chip, tx_work); 3810cab4cb8SJulian Andres Klode unsigned long flags; 3820cab4cb8SJulian Andres Klode long err; 3830cab4cb8SJulian Andres Klode struct nvec_msg *msg; 38432890b98SMarc Dietrich 3850cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags); 3860cab4cb8SJulian Andres Klode while (!list_empty(&nvec->tx_data)) { 3870cab4cb8SJulian Andres Klode msg = list_first_entry(&nvec->tx_data, struct nvec_msg, node); 3880cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags); 3890cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 0); 3900cab4cb8SJulian Andres Klode err = wait_for_completion_interruptible_timeout( 3910cab4cb8SJulian Andres Klode &nvec->ec_transfer, msecs_to_jiffies(5000)); 3920cab4cb8SJulian Andres Klode 3930cab4cb8SJulian Andres Klode if (err == 0) { 3940cab4cb8SJulian Andres Klode dev_warn(nvec->dev, "timeout waiting for ec transfer\n"); 3950cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 1); 3960cab4cb8SJulian Andres Klode msg->pos = 0; 3970cab4cb8SJulian Andres Klode } 3980cab4cb8SJulian Andres Klode 3990cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->tx_lock, flags); 4000cab4cb8SJulian Andres Klode 4010cab4cb8SJulian Andres Klode if (err > 0) { 4020cab4cb8SJulian Andres Klode list_del_init(&msg->node); 4030cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg); 4040cab4cb8SJulian Andres Klode } 4050cab4cb8SJulian Andres Klode } 4060cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->tx_lock, flags); 40732890b98SMarc Dietrich } 40832890b98SMarc Dietrich 409bdf034d9SJulian Andres Klode /** 410bdf034d9SJulian Andres Klode * parse_msg - Print some information and call the notifiers on an RX message 411bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 412bdf034d9SJulian Andres Klode * @msg: A message received by @nvec 413bdf034d9SJulian Andres Klode * 414bdf034d9SJulian Andres Klode * Paarse some pieces of the message and then call the chain of notifiers 415bdf034d9SJulian Andres Klode * registered via nvec_register_notifier. 416bdf034d9SJulian Andres Klode */ 41732890b98SMarc Dietrich static int parse_msg(struct nvec_chip *nvec, struct nvec_msg *msg) 41832890b98SMarc Dietrich { 41932890b98SMarc Dietrich if ((msg->data[0] & 1 << 7) == 0 && msg->data[3]) { 4206a371978SAndy Shevchenko dev_err(nvec->dev, "ec responded %*ph\n", 4, msg->data); 42132890b98SMarc Dietrich return -EINVAL; 42232890b98SMarc Dietrich } 42332890b98SMarc Dietrich 424a3a9aa1aSMarc Dietrich if ((msg->data[0] >> 7) == 1 && (msg->data[0] & 0x0f) == 5) 425a3a9aa1aSMarc Dietrich print_hex_dump(KERN_WARNING, "ec system event ", 426a3a9aa1aSMarc Dietrich DUMP_PREFIX_NONE, 16, 1, msg->data, 427a3a9aa1aSMarc Dietrich msg->data[1] + 2, true); 42832890b98SMarc Dietrich 429162c7d8cSMarc Dietrich atomic_notifier_call_chain(&nvec->notifier_list, msg->data[0] & 0x8f, 430162c7d8cSMarc Dietrich msg->data); 43132890b98SMarc Dietrich 43232890b98SMarc Dietrich return 0; 43332890b98SMarc Dietrich } 43432890b98SMarc Dietrich 435bdf034d9SJulian Andres Klode /** 436bdf034d9SJulian Andres Klode * nvec_dispatch - Process messages received from the EC 437bdf034d9SJulian Andres Klode * @work: A &struct work_struct (the tx_worker member of &struct nvec_chip) 438bdf034d9SJulian Andres Klode * 439bdf034d9SJulian Andres Klode * Process messages previously received from the EC and put into the RX 440bdf034d9SJulian Andres Klode * queue of the &struct nvec_chip instance associated with @work. 441bdf034d9SJulian Andres Klode */ 44232890b98SMarc Dietrich static void nvec_dispatch(struct work_struct *work) 44332890b98SMarc Dietrich { 44432890b98SMarc Dietrich struct nvec_chip *nvec = container_of(work, struct nvec_chip, rx_work); 4450cab4cb8SJulian Andres Klode unsigned long flags; 44632890b98SMarc Dietrich struct nvec_msg *msg; 44732890b98SMarc Dietrich 4480cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->rx_lock, flags); 449162c7d8cSMarc Dietrich while (!list_empty(&nvec->rx_data)) { 45032890b98SMarc Dietrich msg = list_first_entry(&nvec->rx_data, struct nvec_msg, node); 45132890b98SMarc Dietrich list_del_init(&msg->node); 4520cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->rx_lock, flags); 45332890b98SMarc Dietrich 454162c7d8cSMarc Dietrich if (nvec->sync_write_pending == 455162c7d8cSMarc Dietrich (msg->data[2] << 8) + msg->data[0]) { 45632890b98SMarc Dietrich dev_dbg(nvec->dev, "sync write completed!\n"); 45732890b98SMarc Dietrich nvec->sync_write_pending = 0; 45832890b98SMarc Dietrich nvec->last_sync_msg = msg; 45932890b98SMarc Dietrich complete(&nvec->sync_write); 46032890b98SMarc Dietrich } else { 46132890b98SMarc Dietrich parse_msg(nvec, msg); 4620cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg); 46332890b98SMarc Dietrich } 4640cab4cb8SJulian Andres Klode spin_lock_irqsave(&nvec->rx_lock, flags); 46532890b98SMarc Dietrich } 4660cab4cb8SJulian Andres Klode spin_unlock_irqrestore(&nvec->rx_lock, flags); 4670cab4cb8SJulian Andres Klode } 4680cab4cb8SJulian Andres Klode 469bdf034d9SJulian Andres Klode /** 470bdf034d9SJulian Andres Klode * nvec_tx_completed - Complete the current transfer 471bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 472bdf034d9SJulian Andres Klode * 473bdf034d9SJulian Andres Klode * This is called when we have received an END_TRANS on a TX transfer. 474bdf034d9SJulian Andres Klode */ 4750cab4cb8SJulian Andres Klode static void nvec_tx_completed(struct nvec_chip *nvec) 4760cab4cb8SJulian Andres Klode { 4770cab4cb8SJulian Andres Klode /* We got an END_TRANS, let's skip this, maybe there's an event */ 4780cab4cb8SJulian Andres Klode if (nvec->tx->pos != nvec->tx->size) { 4790cab4cb8SJulian Andres Klode dev_err(nvec->dev, "premature END_TRANS, resending\n"); 4800cab4cb8SJulian Andres Klode nvec->tx->pos = 0; 4810cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 0); 4820cab4cb8SJulian Andres Klode } else { 4830cab4cb8SJulian Andres Klode nvec->state = 0; 48432890b98SMarc Dietrich } 48532890b98SMarc Dietrich } 48632890b98SMarc Dietrich 487bdf034d9SJulian Andres Klode /** 488bdf034d9SJulian Andres Klode * nvec_rx_completed - Complete the current transfer 489bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 490bdf034d9SJulian Andres Klode * 491bdf034d9SJulian Andres Klode * This is called when we have received an END_TRANS on a RX transfer. 492bdf034d9SJulian Andres Klode */ 4930cab4cb8SJulian Andres Klode static void nvec_rx_completed(struct nvec_chip *nvec) 4940cab4cb8SJulian Andres Klode { 495210ceb4fSJulian Andres Klode if (nvec->rx->pos != nvec_msg_size(nvec->rx)) { 4960cab4cb8SJulian Andres Klode dev_err(nvec->dev, "RX incomplete: Expected %u bytes, got %u\n", 4970cab4cb8SJulian Andres Klode (uint)nvec_msg_size(nvec->rx), 4980cab4cb8SJulian Andres Klode (uint)nvec->rx->pos); 4990cab4cb8SJulian Andres Klode 500210ceb4fSJulian Andres Klode nvec_msg_free(nvec, nvec->rx); 501210ceb4fSJulian Andres Klode nvec->state = 0; 502d6bdcf2eSJulian Andres Klode 503d6bdcf2eSJulian Andres Klode /* Battery quirk - Often incomplete, and likes to crash */ 504d6bdcf2eSJulian Andres Klode if (nvec->rx->data[0] == NVEC_BAT) 505d6bdcf2eSJulian Andres Klode complete(&nvec->ec_transfer); 506d6bdcf2eSJulian Andres Klode 507210ceb4fSJulian Andres Klode return; 508210ceb4fSJulian Andres Klode } 509210ceb4fSJulian Andres Klode 5100cab4cb8SJulian Andres Klode spin_lock(&nvec->rx_lock); 5110cab4cb8SJulian Andres Klode 51266ad85d1SSimon Guinot /* 51366ad85d1SSimon Guinot * Add the received data to the work list and move the ring buffer 51466ad85d1SSimon Guinot * pointer to the next entry. 51566ad85d1SSimon Guinot */ 5160cab4cb8SJulian Andres Klode list_add_tail(&nvec->rx->node, &nvec->rx_data); 5170cab4cb8SJulian Andres Klode 5180cab4cb8SJulian Andres Klode spin_unlock(&nvec->rx_lock); 5190cab4cb8SJulian Andres Klode 5200cab4cb8SJulian Andres Klode nvec->state = 0; 5210cab4cb8SJulian Andres Klode 5220cab4cb8SJulian Andres Klode if (!nvec_msg_is_event(nvec->rx)) 5230cab4cb8SJulian Andres Klode complete(&nvec->ec_transfer); 5240cab4cb8SJulian Andres Klode 525033d9959SLinus Torvalds schedule_work(&nvec->rx_work); 5260cab4cb8SJulian Andres Klode } 5270cab4cb8SJulian Andres Klode 5280cab4cb8SJulian Andres Klode /** 5290cab4cb8SJulian Andres Klode * nvec_invalid_flags - Send an error message about invalid flags and jump 5300cab4cb8SJulian Andres Klode * @nvec: The nvec device 5310cab4cb8SJulian Andres Klode * @status: The status flags 5320cab4cb8SJulian Andres Klode * @reset: Whether we shall jump to state 0. 5330cab4cb8SJulian Andres Klode */ 5340cab4cb8SJulian Andres Klode static void nvec_invalid_flags(struct nvec_chip *nvec, unsigned int status, 5350cab4cb8SJulian Andres Klode bool reset) 5360cab4cb8SJulian Andres Klode { 5370cab4cb8SJulian Andres Klode dev_err(nvec->dev, "unexpected status flags 0x%02x during state %i\n", 5380cab4cb8SJulian Andres Klode status, nvec->state); 5390cab4cb8SJulian Andres Klode if (reset) 5400cab4cb8SJulian Andres Klode nvec->state = 0; 5410cab4cb8SJulian Andres Klode } 5420cab4cb8SJulian Andres Klode 5430cab4cb8SJulian Andres Klode /** 5440cab4cb8SJulian Andres Klode * nvec_tx_set - Set the message to transfer (nvec->tx) 545bdf034d9SJulian Andres Klode * @nvec: A &struct nvec_chip 546bdf034d9SJulian Andres Klode * 547bdf034d9SJulian Andres Klode * Gets the first entry from the tx_data list of @nvec and sets the 548bdf034d9SJulian Andres Klode * tx member to it. If the tx_data list is empty, this uses the 549bdf034d9SJulian Andres Klode * tx_scratch message to send a no operation message. 5500cab4cb8SJulian Andres Klode */ 5510cab4cb8SJulian Andres Klode static void nvec_tx_set(struct nvec_chip *nvec) 5520cab4cb8SJulian Andres Klode { 5530cab4cb8SJulian Andres Klode spin_lock(&nvec->tx_lock); 5540cab4cb8SJulian Andres Klode if (list_empty(&nvec->tx_data)) { 5550cab4cb8SJulian Andres Klode dev_err(nvec->dev, "empty tx - sending no-op\n"); 5560cab4cb8SJulian Andres Klode memcpy(nvec->tx_scratch.data, "\x02\x07\x02", 3); 5570cab4cb8SJulian Andres Klode nvec->tx_scratch.size = 3; 5580cab4cb8SJulian Andres Klode nvec->tx_scratch.pos = 0; 5590cab4cb8SJulian Andres Klode nvec->tx = &nvec->tx_scratch; 5600cab4cb8SJulian Andres Klode list_add_tail(&nvec->tx->node, &nvec->tx_data); 5610cab4cb8SJulian Andres Klode } else { 5620cab4cb8SJulian Andres Klode nvec->tx = list_first_entry(&nvec->tx_data, struct nvec_msg, 5630cab4cb8SJulian Andres Klode node); 5640cab4cb8SJulian Andres Klode nvec->tx->pos = 0; 5650cab4cb8SJulian Andres Klode } 5660cab4cb8SJulian Andres Klode spin_unlock(&nvec->tx_lock); 5670cab4cb8SJulian Andres Klode 5680cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, "Sending message of length %u, command 0x%x\n", 5690cab4cb8SJulian Andres Klode (uint)nvec->tx->size, nvec->tx->data[1]); 5700cab4cb8SJulian Andres Klode } 5710cab4cb8SJulian Andres Klode 5720cab4cb8SJulian Andres Klode /** 5730cab4cb8SJulian Andres Klode * nvec_interrupt - Interrupt handler 5740cab4cb8SJulian Andres Klode * @irq: The IRQ 5750cab4cb8SJulian Andres Klode * @dev: The nvec device 576bdf034d9SJulian Andres Klode * 577bdf034d9SJulian Andres Klode * Interrupt handler that fills our RX buffers and empties our TX 578bdf034d9SJulian Andres Klode * buffers. This uses a finite state machine with ridiculous amounts 579bdf034d9SJulian Andres Klode * of error checking, in order to be fairly reliable. 5800cab4cb8SJulian Andres Klode */ 581f686e9afSMarc Dietrich static irqreturn_t nvec_interrupt(int irq, void *dev) 58232890b98SMarc Dietrich { 58332890b98SMarc Dietrich unsigned long status; 5840cab4cb8SJulian Andres Klode unsigned int received = 0; 5850cab4cb8SJulian Andres Klode unsigned char to_send = 0xff; 5860cab4cb8SJulian Andres Klode const unsigned long irq_mask = I2C_SL_IRQ | END_TRANS | RCVD | RNW; 5870cab4cb8SJulian Andres Klode struct nvec_chip *nvec = dev; 5880cab4cb8SJulian Andres Klode unsigned int state = nvec->state; 58932890b98SMarc Dietrich 5900cab4cb8SJulian Andres Klode status = readl(nvec->base + I2C_SL_STATUS); 59132890b98SMarc Dietrich 5920cab4cb8SJulian Andres Klode /* Filter out some errors */ 5930cab4cb8SJulian Andres Klode if ((status & irq_mask) == 0 && (status & ~irq_mask) != 0) { 5940cab4cb8SJulian Andres Klode dev_err(nvec->dev, "unexpected irq mask %lx\n", status); 59532890b98SMarc Dietrich return IRQ_HANDLED; 5960cab4cb8SJulian Andres Klode } 5970cab4cb8SJulian Andres Klode if ((status & I2C_SL_IRQ) == 0) { 5980cab4cb8SJulian Andres Klode dev_err(nvec->dev, "Spurious IRQ\n"); 5990cab4cb8SJulian Andres Klode return IRQ_HANDLED; 6000cab4cb8SJulian Andres Klode } 6010cab4cb8SJulian Andres Klode 6020cab4cb8SJulian Andres Klode /* The EC did not request a read, so it send us something, read it */ 6030cab4cb8SJulian Andres Klode if ((status & RNW) == 0) { 6040cab4cb8SJulian Andres Klode received = readl(nvec->base + I2C_SL_RCVD); 60532890b98SMarc Dietrich if (status & RCVD) 6060cab4cb8SJulian Andres Klode writel(0, nvec->base + I2C_SL_RCVD); 6070cab4cb8SJulian Andres Klode } 60832890b98SMarc Dietrich 6090cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RCVD)) 6100cab4cb8SJulian Andres Klode nvec->state = 0; 611162c7d8cSMarc Dietrich 6120cab4cb8SJulian Andres Klode switch (nvec->state) { 6130cab4cb8SJulian Andres Klode case 0: /* Verify that its a transfer start, the rest later */ 6140cab4cb8SJulian Andres Klode if (status != (I2C_SL_IRQ | RCVD)) 6150cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, false); 6160cab4cb8SJulian Andres Klode break; 6170cab4cb8SJulian Andres Klode case 1: /* command byte */ 6180cab4cb8SJulian Andres Klode if (status != I2C_SL_IRQ) { 6190cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 62032890b98SMarc Dietrich } else { 621bb0590e2SJulian Andres Klode nvec->rx = nvec_msg_alloc(nvec, NVEC_MSG_RX); 6228da79863SJulian Andres Klode /* Should not happen in a normal world */ 6238da79863SJulian Andres Klode if (unlikely(nvec->rx == NULL)) { 6248da79863SJulian Andres Klode nvec->state = 0; 6258da79863SJulian Andres Klode break; 6268da79863SJulian Andres Klode } 6270cab4cb8SJulian Andres Klode nvec->rx->data[0] = received; 6280cab4cb8SJulian Andres Klode nvec->rx->pos = 1; 6290cab4cb8SJulian Andres Klode nvec->state = 2; 6300cab4cb8SJulian Andres Klode } 6310cab4cb8SJulian Andres Klode break; 6320cab4cb8SJulian Andres Klode case 2: /* first byte after command */ 6330cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RNW | RCVD)) { 6340cab4cb8SJulian Andres Klode udelay(33); 6350cab4cb8SJulian Andres Klode if (nvec->rx->data[0] != 0x01) { 6360cab4cb8SJulian Andres Klode dev_err(nvec->dev, 6370cab4cb8SJulian Andres Klode "Read without prior read command\n"); 6380cab4cb8SJulian Andres Klode nvec->state = 0; 6390cab4cb8SJulian Andres Klode break; 6400cab4cb8SJulian Andres Klode } 6410cab4cb8SJulian Andres Klode nvec_msg_free(nvec, nvec->rx); 6420cab4cb8SJulian Andres Klode nvec->state = 3; 6430cab4cb8SJulian Andres Klode nvec_tx_set(nvec); 6440cab4cb8SJulian Andres Klode BUG_ON(nvec->tx->size < 1); 6450cab4cb8SJulian Andres Klode to_send = nvec->tx->data[0]; 6460cab4cb8SJulian Andres Klode nvec->tx->pos = 1; 6470cab4cb8SJulian Andres Klode } else if (status == (I2C_SL_IRQ)) { 6480cab4cb8SJulian Andres Klode BUG_ON(nvec->rx == NULL); 6490cab4cb8SJulian Andres Klode nvec->rx->data[1] = received; 6500cab4cb8SJulian Andres Klode nvec->rx->pos = 2; 6510cab4cb8SJulian Andres Klode nvec->state = 4; 65232890b98SMarc Dietrich } else { 6530cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 65432890b98SMarc Dietrich } 6550cab4cb8SJulian Andres Klode break; 6560cab4cb8SJulian Andres Klode case 3: /* EC does a block read, we transmit data */ 6570cab4cb8SJulian Andres Klode if (status & END_TRANS) { 6580cab4cb8SJulian Andres Klode nvec_tx_completed(nvec); 6590cab4cb8SJulian Andres Klode } else if ((status & RNW) == 0 || (status & RCVD)) { 6600cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 6610cab4cb8SJulian Andres Klode } else if (nvec->tx && nvec->tx->pos < nvec->tx->size) { 6620cab4cb8SJulian Andres Klode to_send = nvec->tx->data[nvec->tx->pos++]; 66332890b98SMarc Dietrich } else { 6640cab4cb8SJulian Andres Klode dev_err(nvec->dev, "tx buffer underflow on %p (%u > %u)\n", 6650cab4cb8SJulian Andres Klode nvec->tx, 6660cab4cb8SJulian Andres Klode (uint) (nvec->tx ? nvec->tx->pos : 0), 6670cab4cb8SJulian Andres Klode (uint) (nvec->tx ? nvec->tx->size : 0)); 6680cab4cb8SJulian Andres Klode nvec->state = 0; 6690cab4cb8SJulian Andres Klode } 6700cab4cb8SJulian Andres Klode break; 6710cab4cb8SJulian Andres Klode case 4: /* EC does some write, we read the data */ 6720cab4cb8SJulian Andres Klode if ((status & (END_TRANS | RNW)) == END_TRANS) 6730cab4cb8SJulian Andres Klode nvec_rx_completed(nvec); 6740cab4cb8SJulian Andres Klode else if (status & (RNW | RCVD)) 6750cab4cb8SJulian Andres Klode nvec_invalid_flags(nvec, status, true); 6760cab4cb8SJulian Andres Klode else if (nvec->rx && nvec->rx->pos < NVEC_MSG_SIZE) 6770cab4cb8SJulian Andres Klode nvec->rx->data[nvec->rx->pos++] = received; 6780cab4cb8SJulian Andres Klode else 6790cab4cb8SJulian Andres Klode dev_err(nvec->dev, 680b77f2767SEbru Akagunduz "RX buffer overflow on %p: Trying to write byte %u of %u\n", 6816330f9cfSDan Carpenter nvec->rx, nvec->rx ? nvec->rx->pos : 0, 6826330f9cfSDan Carpenter NVEC_MSG_SIZE); 6830cab4cb8SJulian Andres Klode break; 6840cab4cb8SJulian Andres Klode default: 6850cab4cb8SJulian Andres Klode nvec->state = 0; 68632890b98SMarc Dietrich } 68732890b98SMarc Dietrich 6880cab4cb8SJulian Andres Klode /* If we are told that a new transfer starts, verify it */ 6890cab4cb8SJulian Andres Klode if ((status & (RCVD | RNW)) == RCVD) { 6900cab4cb8SJulian Andres Klode if (received != nvec->i2c_addr) 6910cab4cb8SJulian Andres Klode dev_err(nvec->dev, 6920cab4cb8SJulian Andres Klode "received address 0x%02x, expected 0x%02x\n", 6930cab4cb8SJulian Andres Klode received, nvec->i2c_addr); 6940cab4cb8SJulian Andres Klode nvec->state = 1; 69532890b98SMarc Dietrich } 6960cab4cb8SJulian Andres Klode 6970cab4cb8SJulian Andres Klode /* Send data if requested, but not on end of transmission */ 6980cab4cb8SJulian Andres Klode if ((status & (RNW | END_TRANS)) == RNW) 6990cab4cb8SJulian Andres Klode writel(to_send, nvec->base + I2C_SL_RCVD); 7000cab4cb8SJulian Andres Klode 7010cab4cb8SJulian Andres Klode /* If we have send the first byte */ 7020cab4cb8SJulian Andres Klode if (status == (I2C_SL_IRQ | RNW | RCVD)) 7030cab4cb8SJulian Andres Klode nvec_gpio_set_value(nvec, 1); 7040cab4cb8SJulian Andres Klode 7050cab4cb8SJulian Andres Klode dev_dbg(nvec->dev, 7060cab4cb8SJulian Andres Klode "Handled: %s 0x%02x, %s 0x%02x in state %u [%s%s%s]\n", 7070cab4cb8SJulian Andres Klode (status & RNW) == 0 ? "received" : "R=", 7080cab4cb8SJulian Andres Klode received, 7090cab4cb8SJulian Andres Klode (status & (RNW | END_TRANS)) ? "sent" : "S=", 7100cab4cb8SJulian Andres Klode to_send, 7110cab4cb8SJulian Andres Klode state, 7120cab4cb8SJulian Andres Klode status & END_TRANS ? " END_TRANS" : "", 7130cab4cb8SJulian Andres Klode status & RCVD ? " RCVD" : "", 7140cab4cb8SJulian Andres Klode status & RNW ? " RNW" : ""); 7150cab4cb8SJulian Andres Klode 716de839b8fSJulian Andres Klode /* 717de839b8fSJulian Andres Klode * TODO: A correct fix needs to be found for this. 718de839b8fSJulian Andres Klode * 719de839b8fSJulian Andres Klode * We experience less incomplete messages with this delay than without 720de839b8fSJulian Andres Klode * it, but we don't know why. Help is appreciated. 721de839b8fSJulian Andres Klode */ 722de839b8fSJulian Andres Klode udelay(100); 723de839b8fSJulian Andres Klode 72432890b98SMarc Dietrich return IRQ_HANDLED; 72532890b98SMarc Dietrich } 72632890b98SMarc Dietrich 727f686e9afSMarc Dietrich static void tegra_init_i2c_slave(struct nvec_chip *nvec) 72832890b98SMarc Dietrich { 72932890b98SMarc Dietrich u32 val; 73032890b98SMarc Dietrich 73161c3b197SPrashant Gaikwad clk_prepare_enable(nvec->i2c_clk); 732f686e9afSMarc Dietrich 733c0df5bf5SStephen Warren reset_control_assert(nvec->rst); 73432890b98SMarc Dietrich udelay(2); 735c0df5bf5SStephen Warren reset_control_deassert(nvec->rst); 73632890b98SMarc Dietrich 73732890b98SMarc Dietrich val = I2C_CNFG_NEW_MASTER_SFM | I2C_CNFG_PACKET_MODE_EN | 73832890b98SMarc Dietrich (0x2 << I2C_CNFG_DEBOUNCE_CNT_SHIFT); 739f686e9afSMarc Dietrich writel(val, nvec->base + I2C_CNFG); 74032890b98SMarc Dietrich 741ac810759SMarc Dietrich clk_set_rate(nvec->i2c_clk, 8 * 80000); 742ac810759SMarc Dietrich 743d3f862aeSJulian Andres Klode writel(I2C_SL_NEWSL, nvec->base + I2C_SL_CNFG); 744ac810759SMarc Dietrich writel(0x1E, nvec->base + I2C_SL_DELAY_COUNT); 745ac810759SMarc Dietrich 746ac810759SMarc Dietrich writel(nvec->i2c_addr >> 1, nvec->base + I2C_SL_ADDR1); 747ac810759SMarc Dietrich writel(0, nvec->base + I2C_SL_ADDR2); 748ac810759SMarc Dietrich 749ac810759SMarc Dietrich enable_irq(nvec->irq); 750ac810759SMarc Dietrich } 751ac810759SMarc Dietrich 752ebefae28SMarc Dietrich #ifdef CONFIG_PM_SLEEP 753ac810759SMarc Dietrich static void nvec_disable_i2c_slave(struct nvec_chip *nvec) 754ac810759SMarc Dietrich { 755ac810759SMarc Dietrich disable_irq(nvec->irq); 756d3f862aeSJulian Andres Klode writel(I2C_SL_NEWSL | I2C_SL_NACK, nvec->base + I2C_SL_CNFG); 75761c3b197SPrashant Gaikwad clk_disable_unprepare(nvec->i2c_clk); 75832890b98SMarc Dietrich } 759ebefae28SMarc Dietrich #endif 76032890b98SMarc Dietrich 76132890b98SMarc Dietrich static void nvec_power_off(void) 76232890b98SMarc Dietrich { 76393eff83fSMarc Dietrich char ap_pwr_down[] = { NVEC_SLEEP, AP_PWR_DOWN }; 76493eff83fSMarc Dietrich 765518945fbSMarc Dietrich nvec_toggle_global_events(nvec_power_handle, false); 76693eff83fSMarc Dietrich nvec_write_async(nvec_power_handle, ap_pwr_down, 2); 76732890b98SMarc Dietrich } 76832890b98SMarc Dietrich 76995cd1860SMarc Dietrich /* 77095cd1860SMarc Dietrich * Parse common device tree data 77195cd1860SMarc Dietrich */ 77295cd1860SMarc Dietrich static int nvec_i2c_parse_dt_pdata(struct nvec_chip *nvec) 77395cd1860SMarc Dietrich { 77495cd1860SMarc Dietrich nvec->gpio = of_get_named_gpio(nvec->dev->of_node, "request-gpios", 0); 77595cd1860SMarc Dietrich 77695cd1860SMarc Dietrich if (nvec->gpio < 0) { 77795cd1860SMarc Dietrich dev_err(nvec->dev, "no gpio specified"); 77895cd1860SMarc Dietrich return -ENODEV; 77995cd1860SMarc Dietrich } 78095cd1860SMarc Dietrich 78195cd1860SMarc Dietrich if (of_property_read_u32(nvec->dev->of_node, "slave-addr", 78295cd1860SMarc Dietrich &nvec->i2c_addr)) { 78395cd1860SMarc Dietrich dev_err(nvec->dev, "no i2c address specified"); 78495cd1860SMarc Dietrich return -ENODEV; 78595cd1860SMarc Dietrich } 78695cd1860SMarc Dietrich 78795cd1860SMarc Dietrich return 0; 78895cd1860SMarc Dietrich } 78995cd1860SMarc Dietrich 79046620803SBill Pemberton static int tegra_nvec_probe(struct platform_device *pdev) 79132890b98SMarc Dietrich { 792f686e9afSMarc Dietrich int err, ret; 79332890b98SMarc Dietrich struct clk *i2c_clk; 79432890b98SMarc Dietrich struct nvec_chip *nvec; 79532890b98SMarc Dietrich struct nvec_msg *msg; 796f686e9afSMarc Dietrich struct resource *res; 797f686e9afSMarc Dietrich void __iomem *base; 79893eff83fSMarc Dietrich char get_firmware_version[] = { NVEC_CNTL, GET_FIRMWARE_VERSION }, 79993eff83fSMarc Dietrich unmute_speakers[] = { NVEC_OEM0, 0x10, 0x59, 0x95 }, 80093eff83fSMarc Dietrich enable_event[7] = { NVEC_SYS, CNF_EVENT_REPORTING, true }; 80132890b98SMarc Dietrich 8022c6cbdd0SMarc Dietrich if (!pdev->dev.of_node) { 8032c6cbdd0SMarc Dietrich dev_err(&pdev->dev, "must be instantiated using device tree\n"); 8042c6cbdd0SMarc Dietrich return -ENODEV; 8052c6cbdd0SMarc Dietrich } 8062c6cbdd0SMarc Dietrich 807f5e3352eSMarc Dietrich nvec = devm_kzalloc(&pdev->dev, sizeof(struct nvec_chip), GFP_KERNEL); 8084c42d979SSomya Anand if (!nvec) 80932890b98SMarc Dietrich return -ENOMEM; 8105a9077a8SPawel Lebioda 81132890b98SMarc Dietrich platform_set_drvdata(pdev, nvec); 81232890b98SMarc Dietrich nvec->dev = &pdev->dev; 8137990b0d7SMarc Dietrich 81495cd1860SMarc Dietrich err = nvec_i2c_parse_dt_pdata(nvec); 81595cd1860SMarc Dietrich if (err < 0) 81695cd1860SMarc Dietrich return err; 81732890b98SMarc Dietrich 818f686e9afSMarc Dietrich res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 81997f4be60SThierry Reding base = devm_ioremap_resource(&pdev->dev, res); 82097f4be60SThierry Reding if (IS_ERR(base)) 82197f4be60SThierry Reding return PTR_ERR(base); 82232890b98SMarc Dietrich 823b5b628baSThierry Reding nvec->irq = platform_get_irq(pdev, 0); 824b5b628baSThierry Reding if (nvec->irq < 0) { 825f686e9afSMarc Dietrich dev_err(&pdev->dev, "no irq resource?\n"); 826f5e3352eSMarc Dietrich return -ENODEV; 827f686e9afSMarc Dietrich } 828f686e9afSMarc Dietrich 829c2b62f60SMarc Dietrich i2c_clk = devm_clk_get(&pdev->dev, "div-clk"); 830f686e9afSMarc Dietrich if (IS_ERR(i2c_clk)) { 831f686e9afSMarc Dietrich dev_err(nvec->dev, "failed to get controller clock\n"); 832f5e3352eSMarc Dietrich return -ENODEV; 83332890b98SMarc Dietrich } 83432890b98SMarc Dietrich 835c0df5bf5SStephen Warren nvec->rst = devm_reset_control_get(&pdev->dev, "i2c"); 836c0df5bf5SStephen Warren if (IS_ERR(nvec->rst)) { 837c0df5bf5SStephen Warren dev_err(nvec->dev, "failed to get controller reset\n"); 838c0df5bf5SStephen Warren return PTR_ERR(nvec->rst); 839c0df5bf5SStephen Warren } 840c0df5bf5SStephen Warren 841f686e9afSMarc Dietrich nvec->base = base; 842f686e9afSMarc Dietrich nvec->i2c_clk = i2c_clk; 8430cab4cb8SJulian Andres Klode nvec->rx = &nvec->msg_pool[0]; 844f686e9afSMarc Dietrich 84532890b98SMarc Dietrich ATOMIC_INIT_NOTIFIER_HEAD(&nvec->notifier_list); 84632890b98SMarc Dietrich 84732890b98SMarc Dietrich init_completion(&nvec->sync_write); 8480cab4cb8SJulian Andres Klode init_completion(&nvec->ec_transfer); 8490cab4cb8SJulian Andres Klode mutex_init(&nvec->sync_write_mutex); 8500cab4cb8SJulian Andres Klode spin_lock_init(&nvec->tx_lock); 8510cab4cb8SJulian Andres Klode spin_lock_init(&nvec->rx_lock); 85232890b98SMarc Dietrich INIT_LIST_HEAD(&nvec->rx_data); 8530cab4cb8SJulian Andres Klode INIT_LIST_HEAD(&nvec->tx_data); 85432890b98SMarc Dietrich INIT_WORK(&nvec->rx_work, nvec_dispatch); 85532890b98SMarc Dietrich INIT_WORK(&nvec->tx_work, nvec_request_master); 85632890b98SMarc Dietrich 857f5e3352eSMarc Dietrich err = devm_gpio_request_one(&pdev->dev, nvec->gpio, GPIOF_OUT_INIT_HIGH, 858f5e3352eSMarc Dietrich "nvec gpio"); 859aed92bbcSJulian Andres Klode if (err < 0) { 860aed92bbcSJulian Andres Klode dev_err(nvec->dev, "couldn't request gpio\n"); 861f5e3352eSMarc Dietrich return -ENODEV; 862aed92bbcSJulian Andres Klode } 863aed92bbcSJulian Andres Klode 864f5e3352eSMarc Dietrich err = devm_request_irq(&pdev->dev, nvec->irq, nvec_interrupt, 0, 865f5e3352eSMarc Dietrich "nvec", nvec); 866f686e9afSMarc Dietrich if (err) { 867f686e9afSMarc Dietrich dev_err(nvec->dev, "couldn't request irq\n"); 868f5e3352eSMarc Dietrich return -ENODEV; 869f686e9afSMarc Dietrich } 870ac810759SMarc Dietrich disable_irq(nvec->irq); 871f686e9afSMarc Dietrich 872f686e9afSMarc Dietrich tegra_init_i2c_slave(nvec); 873f686e9afSMarc Dietrich 87432890b98SMarc Dietrich /* enable event reporting */ 875518945fbSMarc Dietrich nvec_toggle_global_events(nvec, true); 87632890b98SMarc Dietrich 87732890b98SMarc Dietrich nvec->nvec_status_notifier.notifier_call = nvec_status_notifier; 87832890b98SMarc Dietrich nvec_register_notifier(nvec, &nvec->nvec_status_notifier, 0); 87932890b98SMarc Dietrich 88032890b98SMarc Dietrich nvec_power_handle = nvec; 88132890b98SMarc Dietrich pm_power_off = nvec_power_off; 88232890b98SMarc Dietrich 88332890b98SMarc Dietrich /* Get Firmware Version */ 88473b37c91STomás Tormo err = nvec_write_sync(nvec, get_firmware_version, 2, &msg); 88532890b98SMarc Dietrich 88673b37c91STomás Tormo if (!err) { 887a4fe05d5SLaura Garcia Liebana dev_warn(nvec->dev, 888a4fe05d5SLaura Garcia Liebana "ec firmware version %02x.%02x.%02x / %02x\n", 889a4fe05d5SLaura Garcia Liebana msg->data[4], msg->data[5], 890a4fe05d5SLaura Garcia Liebana msg->data[6], msg->data[7]); 89132890b98SMarc Dietrich 8920cab4cb8SJulian Andres Klode nvec_msg_free(nvec, msg); 8930cab4cb8SJulian Andres Klode } 89432890b98SMarc Dietrich 8953ec69881SMarc Dietrich ret = mfd_add_devices(nvec->dev, 0, nvec_devices, 89647e7b050SThierry Reding ARRAY_SIZE(nvec_devices), NULL, 0, NULL); 897f686e9afSMarc Dietrich if (ret) 898f686e9afSMarc Dietrich dev_err(nvec->dev, "error adding subdevices\n"); 899f686e9afSMarc Dietrich 90032890b98SMarc Dietrich /* unmute speakers? */ 90193eff83fSMarc Dietrich nvec_write_async(nvec, unmute_speakers, 4); 90232890b98SMarc Dietrich 90332890b98SMarc Dietrich /* enable lid switch event */ 90493eff83fSMarc Dietrich nvec_event_mask(enable_event, LID_SWITCH); 90593eff83fSMarc Dietrich nvec_write_async(nvec, enable_event, 7); 90632890b98SMarc Dietrich 90732890b98SMarc Dietrich /* enable power button event */ 90893eff83fSMarc Dietrich nvec_event_mask(enable_event, PWR_BUTTON); 90993eff83fSMarc Dietrich nvec_write_async(nvec, enable_event, 7); 91032890b98SMarc Dietrich 91132890b98SMarc Dietrich return 0; 91232890b98SMarc Dietrich } 91332890b98SMarc Dietrich 9141a6a8a84SBill Pemberton static int tegra_nvec_remove(struct platform_device *pdev) 91532890b98SMarc Dietrich { 916f686e9afSMarc Dietrich struct nvec_chip *nvec = platform_get_drvdata(pdev); 917f686e9afSMarc Dietrich 918518945fbSMarc Dietrich nvec_toggle_global_events(nvec, false); 919f686e9afSMarc Dietrich mfd_remove_devices(nvec->dev); 920c2b62f60SMarc Dietrich nvec_unregister_notifier(nvec, &nvec->nvec_status_notifier); 921eb1e40a4STejun Heo cancel_work_sync(&nvec->rx_work); 922eb1e40a4STejun Heo cancel_work_sync(&nvec->tx_work); 923fd90ae2cSShailendra Verma /* FIXME: needs check whether nvec is responsible for power off */ 924c2b62f60SMarc Dietrich pm_power_off = NULL; 925f686e9afSMarc Dietrich 92632890b98SMarc Dietrich return 0; 92732890b98SMarc Dietrich } 92832890b98SMarc Dietrich 929ebefae28SMarc Dietrich #ifdef CONFIG_PM_SLEEP 930ebefae28SMarc Dietrich static int nvec_suspend(struct device *dev) 93132890b98SMarc Dietrich { 93273b37c91STomás Tormo int err; 933ebefae28SMarc Dietrich struct platform_device *pdev = to_platform_device(dev); 93432890b98SMarc Dietrich struct nvec_chip *nvec = platform_get_drvdata(pdev); 9359feeb014SMarc Dietrich struct nvec_msg *msg; 93693eff83fSMarc Dietrich char ap_suspend[] = { NVEC_SLEEP, AP_SUSPEND }; 93732890b98SMarc Dietrich 93832890b98SMarc Dietrich dev_dbg(nvec->dev, "suspending\n"); 9399feeb014SMarc Dietrich 9409feeb014SMarc Dietrich /* keep these sync or you'll break suspend */ 94193eff83fSMarc Dietrich nvec_toggle_global_events(nvec, false); 94293eff83fSMarc Dietrich 94373b37c91STomás Tormo err = nvec_write_sync(nvec, ap_suspend, sizeof(ap_suspend), &msg); 94473b37c91STomás Tormo if (!err) 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 9655d30566fSThierry Reding static 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", 979ebefae28SMarc Dietrich .pm = &nvec_pm_ops, 9807990b0d7SMarc Dietrich .of_match_table = nvidia_nvec_of_match, 98132890b98SMarc Dietrich } 98232890b98SMarc Dietrich }; 98332890b98SMarc Dietrich 9849891b1ceSMarc Dietrich module_platform_driver(nvec_device_driver); 985162c7d8cSMarc Dietrich 98632890b98SMarc Dietrich MODULE_ALIAS("platform:nvec"); 987162c7d8cSMarc Dietrich MODULE_DESCRIPTION("NVIDIA compliant embedded controller interface"); 988162c7d8cSMarc Dietrich MODULE_AUTHOR("Marc Dietrich <marvin24@gmx.de>"); 989162c7d8cSMarc Dietrich MODULE_LICENSE("GPL"); 990