Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More keyguard docs

Browse Source 
Starting to set the template for docs, with much more coming.

Test: read the docs
Bug: 195430376
Change-Id: Ie0403bba608520d2be6a5b5d4555c6e8a3deb1ed
This commit is contained in:
Matt Pietal
2021-10-11 12:46:06 -04:00
parent 635fef18d6
commit 1c9e5a9952
3 changed files with 39 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
packages/SystemUI/docs/keyguard.md
View File

@@ -8,5 +8,39 @@ Keyguard is responsible for:
Keyguard is the first screen available when turning on the device, as long as the user has not specified a security method of NONE.
[1]: /frameworks/base/packages/SystemUI/docs/keyguard/bouncer.md
## Critical User Journeys
The journeys below generally refer to Keyguard's portion of the overall flow, especially regarding use of the power button. Power button key interpretation (short press, long press, very long press, multi press) is done in [PhoneWindowManager][4], with calls to [PowerManagerService][2] to sleep or wake up, if needed.
### Power On - AOD enabled or disabled
Begins with the device in low power mode, with the display active for [AOD][3] or inactive. [PowerManagerService][2] can be directed to wake up on various user-configurable signals, such as lift to wake, screen taps, among others. [AOD][2], whether visibly enabled or not, handles these signals to transition AOD to full Lockscreen content. See more in [AOD][3].
### Power Off
An indication to power off the device most likely comes from one of two signals: the user presses the power button or the screen timeout has passed. This may [lock the device](#How-the-device-locks)
#### On Lockscreen
#### On Lockscreen, occluded by an activity
#### Device unlocked, Keyguard has gone away
### Pulsing (Incoming notifications while dozing)
### How the device locks
More coming
* Screen timeout
* Smart lock
* Device policy
* Power button instantly locks setting
* Lock timeout after screen timeout setting
[1]: /frameworks/base/packages/SystemUI/docs/keyguard/bouncer.md
[2]: /frameworks/base/services/core/java/com/android/server/power/PowerManagerService.java
[3]: /frameworks/base/packages/SystemUI/docs/keyguard/aod.md
[4]: /frameworks/base/services/core/java/com/android/server/policy/PhoneWindowManager.java

1
packages/SystemUI/docs/keyguard/aod.md Normal file
View File

@@ -0,0 +1 @@
# Always-on Display (AOD)

6
packages/SystemUI/docs/keyguard/bouncer.md
View File

@@ -7,9 +7,9 @@
The bouncer contains a hierarchy of controllers/views to render the user's security method and to manage the authentication attempts.
1. [KeyguardBouncer][1] - Entrypoint for managing the bouncer visibility.
1. [KeyguardHostViewController][2] - Intercepts media keys. Can most likely be merged with the next item.
1. [KeyguardSecurityContainerController][3] - Manages unlock attempt responses, one-handed use
1. [KeyguardSecurityViewFlipperController][4] - Based upon the [KeyguardSecurityModel#SecurityMode][5], will instantiate the required view and controller. PIN, Pattern, etc.
1. [KeyguardHostViewController][2] - Intercepts media keys. Can most likely be merged with the next item.
1. [KeyguardSecurityContainerController][3] - Manages unlock attempt responses, one-handed use
1. [KeyguardSecurityViewFlipperController][4] - Based upon the [KeyguardSecurityModel#SecurityMode][5], will instantiate the required view and controller. PIN, Pattern, etc.
[1]: /frameworks/base/packages/SystemUI/com/android/systemui/statusbar/phone/KeyguardBouncer
[2]: /frameworks/base/packages/SystemUI/com/android/keyguard/KeyguardHostViewController