Preliminary Platform Driver Support for Lemote Yeeloong Laptops
Subsystems (3)
v3 cover Preliminary Platform Driver Support for Lemote Yeeloong Laptops
v3:
- Style fixes: remove asterisks banners from code comments, use pr_fmt() to format driver messages, remove newlines in mfd_cells retries, fix copyright years.
- Define DEFINE_SPINLOCK(kb3310b_command_lock) as a static variable within kb3310b_query_seq().
- Reword misleading notes on using regmap.
v2:
- Fix the missing io.h header for the MFD driver.
- Use SIMPLE_DEV_PM_OPS instead of the inappropriate .suspend/resume in the SCI driver.
Lemote Yeeloong is a laptop powered by Loongson 2F MIPS processor, primarily a demo platform for hobbyists and developers. It uses an ENE KB3310B Embedded Controller with customized firmware to implement hardware and power management.
Due to the lack of separation of responsibilities and functions between different subsystems, the original platform driver submitted to the mailing list was a piece of monolithic module that implements numerous drivers, as a result, it was never accepted.
This patch series was carefully reorganized and partially reimplemented to avoid those pitfalls in the original driver. This is the first part of the submission, which modifies the core MIPS code to introduce preliminary preparation for other subdrivers. Notably, it leverages a notify chain and MFD cells to avoid introducing unnecessary code into the core MIPS subsystem.
It features the following...
* Create a MFD driver for KB3310B controller, and move the original KB3310B controller code from mips/loongson64 to our new MFD driver. This needs to be reviewed by the MFD subsystem maintainer before the following can proceed.
* Add yeeloong_sci driver support of System Control Interrupt to arch/mips/loongson64/lemote-2f. This piece of code is crucial and has to be included in loongson64/lemote-2f because it reprograms CS5536 southbridge GPIO to handle the underlying interrupts.
* Originally, the SCI code was mixed into the hotkey driver. The new yeeloong_sci driver was written to avoid introducing unrelated subdriver code that is unsuitable for Linux/MIPS. It only handle a minimum set of core operations directly related to the hardware platform, and pass the events to other subdrivers via a notifier chain. As a result, the SCI logic and the specific hotkey handling logic have been decoupled.
* Subdrivers - hwmon, battery, backlight, lcd and hotkey are registered as MFD cells in the MFD driver. It means onlf the MFD driver is resposible to register the upcoming subdrivers, the core board files mips/loongson64/ will not contain unrelated code.
I've done everything I can think of to factor unrelated code out of the MIPS subsystem. I hope the refactored code would be acceptable now. Please review my changeset to see whether it's appropriate.
Thanks,
Yifeng Li (7):
mfd: yeeloong_kb3310b: support KB3310B EC for Lemote Yeeloong laptops.
mips: loongson64: select MFD_YEELOONG_KB3310B for LEMOTE_MACH2F.
mips: loongson64: remove ec_kb3310b.c, use MFD driver.
mips: loongson64: remove yeeloong_report_lid_status from pm.c
mips: loongson64: register per-board platform drivers for lemote-2f
mips: loongson64: Support System Control Interrupts for Lemote
Yeeloong.
MAINTAINERS: add myself as a maintainer of MIPS/Loongson2 platform
code.
MAINTAINERS | 16 + .../include/asm/mach-loongson64/loongson.h | 3 + arch/mips/loongson64/Kconfig | 1 + arch/mips/loongson64/common/platform.c | 15 + arch/mips/loongson64/lemote-2f/Makefile | 2 +- arch/mips/loongson64/lemote-2f/ec_kb3310b.c | 129 ------ arch/mips/loongson64/lemote-2f/ec_kb3310b.h | 188 --------- arch/mips/loongson64/lemote-2f/platform.c | 47 +++ arch/mips/loongson64/lemote-2f/pm.c | 38 +- arch/mips/loongson64/lemote-2f/reset.c | 4 +- arch/mips/loongson64/lemote-2f/sci.c | 394 ++++++++++++++++++ drivers/mfd/Kconfig | 10 + drivers/mfd/Makefile | 1 + drivers/mfd/yeeloong_kb3310b.c | 200 +++++++++ include/linux/mfd/yeeloong_kb3310b.h | 211 ++++++++++ 15 files changed, 909 insertions(+), 350 deletions(-) delete mode 100644 arch/mips/loongson64/lemote-2f/ec_kb3310b.c delete mode 100644 arch/mips/loongson64/lemote-2f/ec_kb3310b.h create mode 100644 arch/mips/loongson64/lemote-2f/platform.c create mode 100644 arch/mips/loongson64/lemote-2f/sci.c create mode 100644 drivers/mfd/yeeloong_kb3310b.c create mode 100644 include/linux/mfd/yeeloong_kb3310b.h
Signature · 1 line
2.20.1
PATCH v3 1/7 mfd: yeeloong_kb3310b: support KB3310B EC for Lemote Yeeloong laptops.
Lemote Yeeloong is a laptop powered by Loongson 2F MIPS processor, primarily a demo platform for hobbyists and developers. It uses an ENE KB3310B Embedded Controller with customized firmware to implement hardware and power management.
A monolithic platform driver code for those functionality has existed out-of-tree for many years. This commit creates a MFD driver for the EC chip on Yeeloong laptop to isolate EC-related code from core MIPS code, and serves as the foundation of various subdrivers.
NOTE: A regmap could be the reasonable abstraction for I/O, but (1) it requires some additional refactoring to convert the shutdown/wakeup routines in board files to subdrivers, and (2) we're only using simple reads/writes, repmap only adds boilerplates to the existing files without additional benefits. We simply export the EC-related functions for now, until we come back to refactor the board files.
--- MAINTAINERS | 7 + drivers/mfd/Kconfig | 10 ++ drivers/mfd/Makefile | 1 + drivers/mfd/yeeloong_kb3310b.c | 200 +++++++++++++++++++++++++ include/linux/mfd/yeeloong_kb3310b.h | 211 +++++++++++++++++++++++++++ 5 files changed, 429 insertions(+) create mode 100644 drivers/mfd/yeeloong_kb3310b.c create mode 100644 include/linux/mfd/yeeloong_kb3310b.h
MAINTAINERS +7 -0
@@ -16839,6 +16839,13 @@ S: Maintained F: Documentation/input/devices/yealink.rst F: drivers/input/misc/yealink.* +YEELOONG ENE KB3310B MFD DRIVER +M: Tom Li <[email protected]> +L: [email protected] +S: Maintained +F: drivers/mfd/yeeloong_kb3310b.c +F: include/linux/mfd/yeeloong_kb3310b.h + Z8530 DRIVER FOR AX.25 M: Joerg Reuter <[email protected]> W: http://yaina.de/jreuter/
drivers/mfd/Kconfig +10 -0
@@ -1872,6 +1872,16 @@ config MFD_STM32_TIMERS for PWM and IIO Timer. This driver allow to share the registers between the others drivers. +config MFD_YEELOONG_KB3310B + bool "ENE KB3310B Embedded Controller on Lemote Yeeloong laptops" + depends on (MIPS && LEMOTE_MACH2F) || COMPILE_TEST + select MFD_CORE + help + Select this option to enable ENE KB3310B Embedded Controller + driver used on Lemote Yeeloong laptops, providing power, battery + and backlight services. This is a mandatory dependency for + Lemote 2F systems. + menu "Multimedia Capabilities Port drivers" depends on ARCH_SA1100
drivers/mfd/Makefile +1 -0
@@ -224,6 +224,7 @@ obj-$(CONFIG_MFD_HI655X_PMIC) += hi655x-pmic.o obj-$(CONFIG_MFD_DLN2) += dln2.o obj-$(CONFIG_MFD_RT5033) += rt5033.o obj-$(CONFIG_MFD_SKY81452) += sky81452.o +obj-$(CONFIG_MFD_YEELOONG_KB3310B) += yeeloong_kb3310b.o intel-soc-pmic-objs := intel_soc_pmic_core.o intel_soc_pmic_crc.o obj-$(CONFIG_INTEL_SOC_PMIC) += intel-soc-pmic.o
drivers/mfd/yeeloong_kb3310b.c new file +200 -0
200 lines not on this page · raw message
include/linux/mfd/yeeloong_kb3310b.h new file +211 -0
211 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v3 2/7 mips: loongson64: select MFD_YEELOONG_KB3310B for LEMOTE_MACH2F.
In reply to Yifeng LiTo ease the support of platform drivers on Lemote Yeeloong laptop, code for accessing the embedded controller has been separated from arch/mips, as a MFD driver. Since the board files here still need to access the EC directly to handle reboot/shutdown and interrupts, we make MFD_YEELOONG_KB3310B as a mandatory dependency.
--- arch/mips/loongson64/Kconfig | 1 + 1 file changed, 1 insertion(+)
arch/mips/loongson64/Kconfig +1 -0
@@ -56,6 +56,7 @@ config LEMOTE_MACH2F select SYS_SUPPORTS_HIGHMEM select SYS_SUPPORTS_LITTLE_ENDIAN select LOONGSON_MC146818 + select MFD_YEELOONG_KB3310B help Lemote Loongson 2F family machines utilize the 2F revision of Loongson processor and the AMD CS5536 south bridge.
Signature · 1 line
2.20.1
PATCH v3 3/7 mips: loongson64: remove ec_kb3310b.c, use MFD driver.
In reply to Yifeng LiWe have already converted the supporting code for ENE KB3310B embedded controller as a separate MFD driver, and select it as a dependency of LEMOTE_MACH2F.
This commit removes the original implementation of ec_kb3310b.c, and converts all EC operations to use the utility function provided by the yeeloong_kb3310b MFD driver instead.
--- arch/mips/loongson64/lemote-2f/Makefile | 2 +- arch/mips/loongson64/lemote-2f/ec_kb3310b.c | 129 -------------- arch/mips/loongson64/lemote-2f/ec_kb3310b.h | 188 -------------------- arch/mips/loongson64/lemote-2f/pm.c | 18 +- arch/mips/loongson64/lemote-2f/reset.c | 4 +- 5 files changed, 12 insertions(+), 329 deletions(-) delete mode 100644 arch/mips/loongson64/lemote-2f/ec_kb3310b.c delete mode 100644 arch/mips/loongson64/lemote-2f/ec_kb3310b.h
arch/mips/loongson64/lemote-2f/Makefile +1 -1
@@ -2,7 +2,7 @@ # Makefile for lemote loongson2f family machines # -obj-y += clock.o machtype.o irq.o reset.o dma.o ec_kb3310b.o +obj-y += clock.o machtype.o irq.o reset.o dma.o # # Suspend Support
arch/mips/loongson64/lemote-2f/ec_kb3310b.c deleted +0 -129
129 lines not on this page · raw message
arch/mips/loongson64/lemote-2f/ec_kb3310b.h deleted +0 -188
188 lines not on this page · raw message
arch/mips/loongson64/lemote-2f/pm.c +9 -9
@@ -23,7 +23,7 @@#include <loongson.h> #include <cs5536/cs5536_mfgpt.h> -#include "ec_kb3310b.h" +#include <linux/mfd/yeeloong_kb3310b.h> #define I8042_KBD_IRQ 1#define I8042_CTR_KBDINT 0x01
@@ -70,7 +70,7 @@ void setup_wakeup_events(void)/* Wakeup CPU via SCI lid open event */ outb (irq_mask & ~(1 <<PIC_CASCADE_IR ),PIC_MASTER_IMR );inb (PIC_MASTER_IMR ); -outb (0xff & ~(1 << (SCI_IRQ_NUM -8 )),PIC_SLAVE_IMR ); +outb (0xff & ~(1 << (KB3310B_SCI_IRQ_NUM -8 )),PIC_SLAVE_IMR );inb (PIC_SLAVE_IMR );break ;
@@ -88,7 +88,7 @@ EXPORT_SYMBOL(yeeloong_report_lid_status);static void yeeloong_lid_update_task (struct work_struct *work) {if (yeeloong_report_lid_status) -yeeloong_report_lid_status (BIT_LID_DETECT_ON ); +yeeloong_report_lid_status (KB3310B_BIT_LID_DETECT_ON ); }int wakeup_loongson (void )
@@ -104,21 +104,21 @@ int wakeup_loongson(void)if (irq ==I8042_KBD_IRQ )return 1 ; -else if (irq ==SCI_IRQ_NUM ) { +else if (irq ==KB3310B_SCI_IRQ_NUM ) {int ret, sci_event;/* query the event number */ - ret =ec_query_seq (CMD_GET_EVENT_NUM ); + ret =kb3310b_query_seq (KB3310B_CMD_GET_EVENT_NUM );if (ret <0 )return 0 ; - sci_event =ec_get_event_num (); + sci_event =kb3310b_get_event_num ();if (sci_event <0 )return 0 ; -if (sci_event ==EVENT_LID ) { +if (sci_event ==KB3310B_EVENT_LID ) {int lid_status;/* check the LID status */ - lid_status =ec_read (REG_LID_DETECT ); + lid_status =kb3310b_read (KB3310B_REG_LID_DETECT );/* wakeup cpu when people open the LID */ -if (lid_status ==BIT_LID_DETECT_ON ) { +if (lid_status ==KB3310B_BIT_LID_DETECT_ON ) {/* If we call it directly here, the WARNING * will be sent out by getnstimeofday * via "WARN_ON(timekeeping_suspended);"
arch/mips/loongson64/lemote-2f/reset.c +2 -2
@@ -20,7 +20,7 @@#include <loongson.h> #include <cs5536/cs5536.h> -#include "ec_kb3310b.h" +#include <linux/mfd/yeeloong_kb3310b.h> static void reset_cpu (void ) {
@@ -81,7 +81,7 @@ static void ml2f_reboot(void)reset_cpu ();/* sending an reset signal to EC(embedded controller) */ -ec_write (REG_RESET ,BIT_RESET_ON ); +kb3310b_write (KB3310B_REG_RESET ,KB3310B_BIT_RESET_ON ); }#define yl2f89_reboot ml2f_reboot
Signature · 1 line
2.20.1
PATCH v3 4/7 mips: loongson64: remove yeeloong_report_lid_status from pm.c
In reply to Yifeng LiThere is some complicated logic in lemote-2f/pm.c. During wakeup, it creates a delayed_work to execute a callback to the function yeeloong_report_lid_status(). It's only purpose is to report the current status of the laptop lid switch, and this callback function was not implemented in the mainline kernel.
This level of overenginnering hardly makes sense. All we need is to report the laptop lid switch unconditionally upon wakeup in the future PM code, which is being worked on.
--- arch/mips/loongson64/lemote-2f/pm.c | 22 ---------------------- 1 file changed, 22 deletions(-)
arch/mips/loongson64/lemote-2f/pm.c +0 -22
@@ -80,17 +80,6 @@ void setup_wakeup_events(void) } } -static struct delayed_work lid_task; -static int initialized; -/* yeeloong_report_lid_status will be implemented in yeeloong_laptop.c */ -sci_handler yeeloong_report_lid_status; -EXPORT_SYMBOL (yeeloong_report_lid_status); -static void yeeloong_lid_update_task (struct work_struct *work) -{ -if (yeeloong_report_lid_status) -yeeloong_report_lid_status (KB3310B_BIT_LID_DETECT_ON ); -} -int wakeup_loongson (void ) {int irq;
@@ -119,17 +108,6 @@ int wakeup_loongson(void) lid_status =kb3310b_read (KB3310B_REG_LID_DETECT );/* wakeup cpu when people open the LID */ if (lid_status ==KB3310B_BIT_LID_DETECT_ON ) { -/* If we call it directly here, the WARNING -* will be sent out by getnstimeofday -* via "WARN_ON(timekeeping_suspended);" -* because we can not schedule in suspend mode. -*/ -if (initialized ==0 ) { -INIT_DELAYED_WORK (&lid_task, - yeeloong_lid_update_task); - initialized =1 ; - } -schedule_delayed_work (&lid_task,1 );return 1 ; } }
Signature · 1 line
2.20.1
PATCH v3 5/7 mips: loongson64: register per-board platform drivers for lemote-2f
In reply to Yifeng LiCurrently, common/platform.c registers the Loongson 2F cpufreq driver during boot time for all boards. To support platform drivers for Lemote Yeeloong laptops, we need to register more drivers.
First, we add support for per-board platform drivers. Just like how IRQ, DMA, or reset logic is implemented for each board, we introduces a call of mach_platform_init() in common/platform.c, to allow each board to have its own platform.c to register platform drivers.
Then, we implement lemote-2f/platform.c to register the MFD driver for Yeeloong laptops.
So far, only one board, lemote-f2, is using this facility, so we hardcode the call of mach_platform_init() in common/platform.c as a ifdef for now.
--- .../include/asm/mach-loongson64/loongson.h | 3 ++ arch/mips/loongson64/common/platform.c | 15 ++++++ arch/mips/loongson64/lemote-2f/Makefile | 2 +- arch/mips/loongson64/lemote-2f/platform.c | 47 +++++++++++++++++++ 4 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 arch/mips/loongson64/lemote-2f/platform.c
arch/mips/include/asm/mach-loongson64/loongson.h +3 -0
@@ -23,6 +23,9 @@ extern void bonito_irq_init(void);extern void mach_prepare_reboot (void );extern void mach_prepare_shutdown (void ); +/* machine-specific platform driver registration */ +extern int mach_platform_init (void )__init ; +/* environment arguments from bootloader */ extern u32 cpu_clock_freq;extern u32 memsize, highmemsize;
arch/mips/loongson64/common/platform.c +15 -0
@@ -11,6 +11,7 @@#include <linux/err.h> #include <linux/smp.h> #include <linux/platform_device.h> +#include <loongson.h> static struct platform_device loongson2_cpufreq_device = { .name ="loongson2_cpufreq" ,
@@ -29,3 +30,17 @@ static int __init loongson2_cpufreq_init(void) }arch_initcall (loongson2_cpufreq_init); + +/* +* Currently, only LEMOTE_MACH2F implements mach_platform_init(); +* Fuloong-2E or Loongson3 does not have platform drivers to register +* at here yet. +*/ +#ifdef CONFIG_LEMOTE_MACH2F +static int __init loongson2_platform_init (void ) +{ +return mach_platform_init (); +} + +device_initcall (loongson2_platform_init); +#endif
arch/mips/loongson64/lemote-2f/Makefile +1 -1
@@ -2,7 +2,7 @@ # Makefile for lemote loongson2f family machines # -obj-y += clock.o machtype.o irq.o reset.o dma.o +obj-y += clock.o machtype.o irq.o reset.o dma.o platform.o # # Suspend Support
arch/mips/loongson64/lemote-2f/platform.c new file +47 -0
47 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v3 6/7 mips: loongson64: Support System Control Interrupts for Lemote Yeeloong.
In reply to Yifeng LiThe hardware design of Yeeloong laptops is similar to OLPC: low-level hardware events are processed by the ENE KB3310B Embedded Controller, which is connected to the AMD CS5536 southbridge through a GPIO port.
When a hardware event occurs, such as a short-circuit on the USB port, removing the power supply, plugging in a VGA adapter, opening the lid of the laptop, or pressing a hotkey on the keyboard, the EC sends a pulse to CS5536, which then fires a System Control Interrupt to notify the kernel.
In the previous attempted submission, the logic for handling SCI and hotkeys was tightly-coupled, and the driver was called the "hotkey" driver, which was misleading. In this implementation of sci.c, we only handle the minimum number of things that deal with the underlying platform hardware directly, such as setting up the CS5536 GPIO and IRQ, handling the the power supply of USB and camera. The vast majority of events are passed to the subdrivers via a notification chain, thus, the SCI logic and the specific hotkey handling logic have been decoupled.
--- arch/mips/loongson64/lemote-2f/Makefile | 2 +- arch/mips/loongson64/lemote-2f/sci.c | 394 ++++++++++++++++++++++++ 2 files changed, 395 insertions(+), 1 deletion(-) create mode 100644 arch/mips/loongson64/lemote-2f/sci.c
arch/mips/loongson64/lemote-2f/Makefile +1 -1
@@ -2,7 +2,7 @@ # Makefile for lemote loongson2f family machines # -obj-y += clock.o machtype.o irq.o reset.o dma.o platform.o +obj-y += clock.o machtype.o irq.o reset.o dma.o platform.o sci.o # # Suspend Support
arch/mips/loongson64/lemote-2f/sci.c new file +394 -0
394 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v3 7/7 MAINTAINERS: add myself as a maintainer of MIPS/Loongson2 platform code.
In reply to Yifeng LiI've introduced platform code for Lemote Yeeloong computers and modified power management-related files. Add myself as a maintainer of these code.
--- MAINTAINERS | 9 +++++++++ 1 file changed, 9 insertions(+)
MAINTAINERS +9 -0
@@ -10134,6 +10134,15 @@ F: arch/mips/include/asm/mach-loongson64/ F: drivers/*/*loongson2* F: drivers/*/*/*loongson2* +MIPS/LOONGSON2 LEMOTE PLATFORM AND POWER MANAGEMENT DRIVER +M: Tom Li <[email protected]> +L: [email protected] +S: Maintained +F: arch/mips/loongson64/common/platform.c +F: arch/mips/loongson64/lemote-2f/pm.c +F: arch/mips/loongson64/lemote-2f/sci.c +F: arch/mips/loongson64/lemote-2f/platform.c + MIPS/LOONGSON3 ARCHITECTURE M: Huacai Chen <[email protected]> L: [email protected]
Signature · 1 line
2.20.1