Difference between revisions of "ACPI/Board-EC interaction"

From coreboot
Jump to: navigation, search
(The hammer method)
(Hotkey and event methods)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This page details the required interface and implementation details for connecting embedded controller ASL files to mainboard ASL files. Implementing this specification is mandatory for every new mainboard/EC added to the tree.
 
This page details the required interface and implementation details for connecting embedded controller ASL files to mainboard ASL files. Implementing this specification is mandatory for every new mainboard/EC added to the tree.
 
<span style="background:red">WARNING! The rules presented here are still a work-in-progress and should not yet be taken as as mandatory.</span> However, if you are implementing a new EC, mainboard, or are interested in refactoring existing ASL files, you should join in the conversation and get this specification finalized.
 
  
 
EC ASL files should be self-contained, and not depend on the specific chipset or mainboard. As a result all variables and methods which are used must be standardized to foster interoperability and modularity. This specification details how to achieve those points.
 
EC ASL files should be self-contained, and not depend on the specific chipset or mainboard. As a result all variables and methods which are used must be standardized to foster interoperability and modularity. This specification details how to achieve those points.
  
== Hotkey event methods ==
+
== System Resources ==
 
 
Two proposals exist:
 
 
 
=== The hammer method ===
 
 
 
Define a set of common ACPI method names which the mainboard code should define, and the EC code can always use.
 
  
The mainboard must #define these to an existing method. The actual ASL methods must not use these long names in ASL. The "MB_" prefix indicates that the mainboard  is providing these methods.
+
All ECs are assumed to use IO ports '''0x62''' and '''0x66''' for data/commands. If the EC also serves as a keyboard controller, it is assumed to use ports '''0x60''' and '''0x64'''. I/O port accesses to these ports must be directed to the bus to which the EC is connected. These need not be individually documented.
  
Notice that these methods are only called on hotkey events. As such, unless the user has really fast fingers, there isn't a huge ACPI overhead as opposed to setting/clearing the needed bits directly in the caller.
+
If the EC uses different ports, or needs other system resources, those must be documented in '''src/ec/vendor/model/documentation.txt'''
  
* MB_TOGGLE_WLAN() or MB_TOGGLE_WIRELESS() (TODO: only one method should be defined!!!)
+
== Defined constants ==
** Toggle wireless LAN on and off, or wireless LAN and bluetooth (respectively). EC calls this on hotkey events.
 
  
* MB_INCREASE_BRIGHTNESS() and MB_DECREASE_BRIGHTNESS()
+
* EC_SCI_GPE
** Increase or decrease screen brightness. EC calls this on hotkey events.
+
** The general purpose event (GPE) corresponding to the EC SCI line.
  
* MB_SWITCH_DISPLAY()
+
== Hotkey and event methods ==
** Switch the active display. EC calls this on hotkey events.
 
  
* MB_NOTIFY_POWER_EVENT()
+
Provide a generic mainboard device in the '''\_SB''' scope with a set of pre-defined methods. This way, the EC can pass events to the mainboard for handling.
** Handle power state notifications and notify CPU device objects to re-evaluate their _PPC and _CST tables.
 
  
For example:
+
The mainboard is not required to implement all methods, however, it must provide all such methods for the EC. The EC can call any of these methods. If the EC requires a method which is not part of the standard set, the this fact must be documented '''src/ec/vendor/model/documentation.txt'''.
  
  /* Brightness up hotkey event */
+
  Device (MB) {
Method (_Q11) {                
+
/* Lid open */
        MB_INCREASE_BRIGHTNESS();
+
Method (LIDO) { /* Stub */ }
}
+
/* Lid closed */
+
Method (LIDC) { /* Stub */}
/* Brightness down hotkey event */
+
/* Increase brightness */
Method (_Q12) {                
+
Method (BRTU) { /* Stub */ }
        MB_DECREASE_BRIGHTNESS();
+
/* Decrease brightness */
}
+
Method (BRTD) { /* Stub */ }
+
  /* Switch display */
/* Wireless on/off hotkey event */
+
Method (DSPS) { /* Stub */ }
Method (_Q1C) {                
+
/* Toggle wireless */
        MB_TOGGLE_WIRELESS();
+
Method (WLTG) { /* Stub */ }
 +
/* Decrease brightness */
 +
Method (LIDS) { /* Stub */ }
 
  }
 
  }
  
=== The mainboard handler method ===
+
These methods should be called by the EC using the '''\_SB.MB''' scope:
  
Provide a generic mainboard "EC event" method that any EC _Qxx could call and pass the event ID to. The event ID is a standard defined event ID , greater than 255 so as not to conflict with possible Qxx IDs.  This limits the permutations of mainboard EC event handlers and gives the flexibility to pass all the various EC events to the mainboard for handling.
+
  /* Decrease brightness hotkey */
 
+
  Method (_Q11, 0, NotSerialized)
For example:
+
{
 
+
\_SB.MB.BRTD()
#define EC_EVENT_LID_CLOSED 0x100
 
 
 
In the EC ASL:
 
 
 
  /* lid closed */
 
  Method (_Q01) {                
 
        \_SB.MBEC (EC_EVENT_LID_CLOSED)
 
 
  }
 
  }
  
And the mainboard handler could look like:
+
== EC-specific extensions ==
  
Scope (\_SB)
+
The EC may provide specific extensions to this specifications. However, any such extension must be fully documented in '''src/ec/vendor/model/documentation.txt'''. The EC must be able to function properly even if the mainboard does not define or use such extensions.
{
 
        /* mainboard event handler */
 
        Method (MBEC, 1, Serialized) {
 
        Switch (ToInteger (Arg0)) {
 
                Case (EC_EVENT_LID_CLOSED) { ... }
 
                Case (EC_EVENT_...) { ... }
 
        }
 
  }
 

Latest revision as of 03:37, 19 April 2014

This page details the required interface and implementation details for connecting embedded controller ASL files to mainboard ASL files. Implementing this specification is mandatory for every new mainboard/EC added to the tree.

EC ASL files should be self-contained, and not depend on the specific chipset or mainboard. As a result all variables and methods which are used must be standardized to foster interoperability and modularity. This specification details how to achieve those points.

System Resources

All ECs are assumed to use IO ports 0x62 and 0x66 for data/commands. If the EC also serves as a keyboard controller, it is assumed to use ports 0x60 and 0x64. I/O port accesses to these ports must be directed to the bus to which the EC is connected. These need not be individually documented.

If the EC uses different ports, or needs other system resources, those must be documented in src/ec/vendor/model/documentation.txt

Defined constants

  • EC_SCI_GPE
    • The general purpose event (GPE) corresponding to the EC SCI line.

Hotkey and event methods

Provide a generic mainboard device in the \_SB scope with a set of pre-defined methods. This way, the EC can pass events to the mainboard for handling.

The mainboard is not required to implement all methods, however, it must provide all such methods for the EC. The EC can call any of these methods. If the EC requires a method which is not part of the standard set, the this fact must be documented src/ec/vendor/model/documentation.txt.

Device (MB) {
	/* Lid open */
	Method (LIDO) { /* Stub */ }
	/* Lid closed */
	Method (LIDC) { /* Stub */}
	/* Increase brightness */
	Method (BRTU) { /* Stub */ }
	/* Decrease brightness */
	Method (BRTD) { /* Stub */ }
 	/* Switch display */
	Method (DSPS) { /* Stub */ }
	/* Toggle wireless */
	Method (WLTG) { /* Stub */ }
	/* Decrease brightness */
	Method (LIDS) { /* Stub */ }
}

These methods should be called by the EC using the \_SB.MB scope:

/* Decrease brightness hotkey */
Method (_Q11, 0, NotSerialized)
{
	\_SB.MB.BRTD()
}

EC-specific extensions

The EC may provide specific extensions to this specifications. However, any such extension must be fully documented in src/ec/vendor/model/documentation.txt. The EC must be able to function properly even if the mainboard does not define or use such extensions.