src/ec/lenovo/h8/h8.c

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2
   3 #include <acpi/acpi.h>
   4 #include <console/console.h>
   5 #include <device/device.h>
   6 #include <device/pnp.h>
   7 #include <ec/acpi/ec.h>
   8 #include <stdio.h>
   9 #include <string.h>
  10 #include <smbios.h>
  11 #include <option.h>
  12 #include <pc80/keyboard.h>
  13 #include <types.h>
  14
  15 #include "h8.h"
  16 #include "chip.h"
  17
  18 void h8_trackpoint_enable(int on)
  19 {
  20         ec_write(H8_TRACKPOINT_CTRL,
  21                  on ? H8_TRACKPOINT_ON : H8_TRACKPOINT_OFF);
  22 }
  23
  24 /* Controls radio-off pin in WLAN MiniPCIe slot.  */
  25 void h8_wlan_enable(int on)
  26 {
  27         if (on)
  28                 ec_set_bit(0x3a, 5);
  29         else
  30                 ec_clr_bit(0x3a, 5);
  31 }
  32
  33 /* Controls radio-off pin in UWB MiniPCIe slot.  */
  34 static void h8_uwb_enable(int on)
  35 {
  36         if (on)
  37                 ec_set_bit(0x31, 2);
  38         else
  39                 ec_clr_bit(0x31, 2);
  40 }
  41
  42 static void h8_fn_ctrl_swap(int on)
  43 {
  44         if (on)
  45                 ec_set_bit(0xce, 4);
  46         else
  47                 ec_clr_bit(0xce, 4);
  48 }
  49
  50 enum battery {
  51         SECONDARY_BATTERY = 0,
  52         PRIMARY_BATTERY = 1,
  53 };
  54
  55 /* h8 charge priority. Defines if primary or secondary
  56  * battery is charged first.
  57  * Because NVRAM is complete the other way around as this register,
  58  * it's inverted by if
  59  */
  60 static void h8_charge_priority(enum battery battery)
  61 {
  62         if (battery == PRIMARY_BATTERY)
  63                 ec_clr_bit(0x0, 4);
  64         else
  65                 ec_set_bit(0x0, 4);
  66 }
  67
  68 static void h8_sticky_fn(int on)
  69 {
  70         if (on)
  71                 ec_set_bit(0x0, 3);
  72         else
  73                 ec_clr_bit(0x0, 3);
  74 }
  75
  76 static void f1_to_f12_as_primary(int on)
  77 {
  78         if (on)
  79                 ec_set_bit(0x3b, 3);
  80         else
  81                 ec_clr_bit(0x3b, 3);
  82 }
  83
  84 static void h8_log_ec_version(void)
  85 {
  86         char ecfw[17];
  87         u8 len;
  88         u16 fwvh, fwvl;
  89
  90         len = h8_build_id_and_function_spec_version(ecfw, sizeof(ecfw) - 1);
  91         ecfw[len] = 0;
  92
  93         fwvh = ec_read(0xe9);
  94         fwvl = ec_read(0xe8);
  95
  96         printk(BIOS_INFO, "H8: EC Firmware ID %s, Version %d.%d%d%c\n", ecfw,
  97                fwvh >> 4, fwvh & 0x0f, fwvl >> 4, 0x41 + (fwvl & 0xf));
  98 }
  99
 100 void h8_set_audio_mute(int mute)
 101 {
 102         if (mute)
 103                 ec_set_bit(0x3a, 0);
 104         else
 105                 ec_clr_bit(0x3a, 0);
 106 }
 107
 108 void h8_enable_event(int event)
 109 {
 110         if (event < 0 || event > 127)
 111                 return;
 112
 113         ec_set_bit(0x10 + (event >> 3), event & 7);
 114 }
 115
 116 void h8_disable_event(int event)
 117 {
 118         if (event < 0 || event > 127)
 119                 return;
 120
 121         ec_clr_bit(0x10 + (event >> 3), event & 7);
 122 }
 123
 124 void h8_usb_always_on_enable(enum usb_always_on on)
 125 {
 126         u8 val;
 127
 128         switch (on) {
 129         case UAO_OFF:
 130                 val = ec_read(H8_USB_ALWAYS_ON);
 131                 // Clear bits 0,2,3
 132                 val &= ~(H8_USB_ALWAYS_ON_ENABLE | H8_USB_ALWAYS_ON_AC_ONLY);
 133                 ec_write(H8_USB_ALWAYS_ON, val);
 134                 break;
 135
 136         case UAO_AC_AND_BATTERY:
 137                 val = ec_read(H8_USB_ALWAYS_ON);
 138                 val |= H8_USB_ALWAYS_ON_ENABLE; // Set bit 0
 139                 val &= ~H8_USB_ALWAYS_ON_AC_ONLY; // Clear bits 2 and 3
 140                 ec_write(H8_USB_ALWAYS_ON, val);
 141                 break;
 142
 143         case UAO_AC_ONLY:
 144                 val = ec_read(H8_USB_ALWAYS_ON);
 145                 // Set bits 0,2,3
 146                 val |= (H8_USB_ALWAYS_ON_ENABLE | H8_USB_ALWAYS_ON_AC_ONLY);
 147                 ec_write(H8_USB_ALWAYS_ON, val);
 148                 break;
 149         }
 150 }
 151
 152 void h8_usb_power_enable(int onoff)
 153 {
 154         if (onoff)
 155                 ec_set_bit(0x3b, 4);
 156         else
 157                 ec_clr_bit(0x3b, 4);
 158 }
 159
 160 int h8_ultrabay_device_present(void)
 161 {
 162         return ec_read(H8_STATUS1) & 0x5 ? 0 : 1;
 163 }
 164
 165 u8 h8_build_id_and_function_spec_version(char *buf, u8 buf_len)
 166 {
 167         u8 i, c;
 168         char str[16 + 1]; /* 16 ASCII chars + \0 */
 169
 170         /* Build ID */
 171         for (i = 0; i < 8; i++) {
 172                 c = ec_read(0xf0 + i);
 173                 if (c < 0x20 || c > 0x7f) {
 174                         i = snprintf(str, sizeof(str), "*INVALID");
 175                         break;
 176                 }
 177                 str[i] = c;
 178         }
 179
 180         /* EC firmware function specification version */
 181         i += snprintf(str + i, sizeof(str) - i, "-%u.%u", ec_read(0xef), ec_read(0xeb));
 182
 183         i = MIN(buf_len, i);
 184         memcpy(buf, str, i);
 185
 186         return i;
 187 }
 188
 189 #if CONFIG(GENERATE_SMBIOS_TABLES)
 190 static void h8_smbios_strings(struct device *dev, struct smbios_type11 *t)
 191 {
 192         char tpec[] = "IBM ThinkPad Embedded Controller -[                 ]-";
 193
 194         h8_build_id_and_function_spec_version(tpec + 35, 17);
 195
 196         t->count = smbios_add_string(t->eos, tpec);
 197 }
 198 #endif
 199
 200 static void h8_init(struct device *dev)
 201 {
 202         pc_keyboard_init(NO_AUX_DEVICE);
 203 }
 204
 205 #if CONFIG(HAVE_ACPI_TABLES)
 206 static const char *h8_acpi_name(const struct device *dev)
 207 {
 208         return "EC";
 209 }
 210 #endif
 211
 212 struct device_operations h8_dev_ops = {
 213 #if CONFIG(GENERATE_SMBIOS_TABLES)
 214         .get_smbios_strings = h8_smbios_strings,
 215 #endif
 216 #if CONFIG(HAVE_ACPI_TABLES)
 217         .acpi_fill_ssdt = h8_ssdt_generator,
 218         .acpi_name = h8_acpi_name,
 219 #endif
 220         .init = h8_init,
 221 };
 222
 223 void __weak h8_mb_init(void){ /* NOOP */ }
 224
 225 static void h8_enable(struct device *dev)
 226 {
 227         struct ec_lenovo_h8_config *conf = dev->chip_info;
 228         u8 val;
 229         u8 beepmask0, beepmask1, reg8;
 230
 231         dev->ops = &h8_dev_ops;
 232
 233         ec_clear_out_queue();
 234         h8_log_ec_version();
 235
 236         /* Always enable I/O range 0x1600-0x160f and thermal management */
 237         reg8 = conf->config0;
 238         reg8 |= H8_CONFIG0_SMM_H8_ENABLE;
 239         reg8 |= H8_CONFIG0_TC_ENABLE;
 240         ec_write(H8_CONFIG0, reg8);
 241
 242         reg8 = conf->config1;
 243         if (conf->has_keyboard_backlight) {
 244                 /* Default to both backlights */
 245                 reg8 = (reg8 & 0xf3) | ((get_uint_option("backlight", 0) & 0x3) << 2);
 246         }
 247         ec_write(H8_CONFIG1, reg8);
 248         ec_write(H8_CONFIG2, conf->config2);
 249         ec_write(H8_CONFIG3, conf->config3);
 250
 251         beepmask0 = conf->beepmask0;
 252         beepmask1 = conf->beepmask1;
 253
 254         if (conf->has_power_management_beeps) {
 255                 if (get_uint_option("power_management_beeps", 1) == 0) {
 256                         beepmask0 = 0x00;
 257                         beepmask1 = 0x00;
 258                 }
 259         }
 260
 261         if (conf->has_power_management_beeps) {
 262                 if (get_uint_option("low_battery_beep", 1))
 263                         beepmask0 |= 2;
 264                 else
 265                         beepmask0 &= ~2;
 266         }
 267
 268         ec_write(H8_SOUND_ENABLE0, beepmask0);
 269         ec_write(H8_SOUND_ENABLE1, beepmask1);
 270
 271         /* silence sounds in queue */
 272         ec_write(H8_SOUND_REPEAT, 0x00);
 273         ec_write(H8_SOUND_REG, 0x00);
 274
 275         ec_write(0x10, conf->event0_enable);
 276         ec_write(0x11, conf->event1_enable);
 277         ec_write(0x12, conf->event2_enable);
 278         ec_write(0x13, conf->event3_enable);
 279         ec_write(0x14, conf->event4_enable);
 280         ec_write(0x15, conf->event5_enable);
 281         ec_write(0x16, conf->event6_enable);
 282         ec_write(0x17, conf->event7_enable);
 283         ec_write(0x18, conf->event8_enable);
 284         ec_write(0x19, conf->event9_enable);
 285         ec_write(0x1a, conf->eventa_enable);
 286         ec_write(0x1b, conf->eventb_enable);
 287         ec_write(0x1c, conf->eventc_enable);
 288         ec_write(0x1d, conf->eventd_enable);
 289         ec_write(0x1e, conf->evente_enable);
 290         ec_write(0x1f, conf->eventf_enable);
 291
 292         ec_write(H8_FAN_CONTROL, H8_FAN_CONTROL_AUTO);
 293
 294         h8_usb_always_on_enable(get_uint_option("usb_always_on", 0));
 295
 296         h8_wlan_enable(get_uint_option("wlan", 1));
 297
 298         h8_trackpoint_enable(1);
 299         h8_usb_power_enable(1);
 300
 301         unsigned int volume = get_uint_option("volume", ~0);
 302         if (volume <= 0xff && !acpi_is_wakeup_s3())
 303                 ec_write(H8_VOLUME_CONTROL, volume);
 304
 305         val = (CONFIG(H8_SUPPORT_BT_ON_WIFI) || h8_has_bdc(dev)) &&
 306                 h8_bluetooth_nv_enable();
 307         h8_bluetooth_enable(val);
 308
 309         val = h8_has_wwan(dev) && h8_wwan_nv_enable();
 310         h8_wwan_enable(val);
 311
 312         if (conf->has_uwb)
 313                 h8_uwb_enable(get_uint_option("uwb", 1));
 314
 315         h8_fn_ctrl_swap(get_uint_option("fn_ctrl_swap", CONFIG(H8_FN_CTRL_SWAP)));
 316
 317         h8_sticky_fn(get_uint_option("sticky_fn", 0));
 318
 319         if (CONFIG(H8_HAS_PRIMARY_FN_KEYS))
 320                 f1_to_f12_as_primary(get_uint_option("f1_to_f12_as_primary", 1));
 321
 322         h8_charge_priority(get_uint_option("first_battery", PRIMARY_BATTERY));
 323
 324         h8_set_audio_mute(0);
 325         h8_mb_init();
 326 }
 327
 328 struct chip_operations ec_lenovo_h8_ops = {
 329         .name = "Lenovo H8 EC",
 330         .enable_dev = h8_enable,
 331 };