| Message ID | 20241129045750.456251-1-rdunlap@infradead.org |
|---|---|
| State | New |
| Headers | show |
| Series | kernel.h: add comments for system_states | expand |
On Fri, Nov 29, 2024 at 5:57 AM Randy Dunlap <rdunlap@infradead.org> wrote: > > Provide some basic comments about the system_states and what they imply. > Also convert the comments to kernel-doc format. > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: "Rafael J. Wysocki" <rafael@kernel.org> > Cc: Pavel Machek <pavel@ucw.cz> > Cc: Len Brown <len.brown@intel.com> > Cc: linux-pm@vger.kernel.org > Cc: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com> Fine by me. Acked-by: Rafael J. Wysocki <rafael@kernel.org> > --- > include/linux/kernel.h | 14 ++++++++++++-- > 1 file changed, 12 insertions(+), 2 deletions(-) > > --- linux-next-20241125.orig/include/linux/kernel.h > +++ linux-next-20241125/include/linux/kernel.h > @@ -176,9 +176,19 @@ extern int root_mountflags; > > extern bool early_boot_irqs_disabled; > > -/* > - * Values used for system_state. Ordering of the states must not be changed > +/** > + * enum system_states - Values used for system_state. > + * Ordering of the states must not be changed > * as code checks for <, <=, >, >= STATE. > + * > + * @SYSTEM_BOOTING: %0, no init needed > + * @SYSTEM_SCHEDULING: system is ready for scheduling; OK to use RCU > + * @SYSTEM_FREEING_INITMEM: system is freeing all of initmem; almost running > + * @SYSTEM_RUNNING: system is up and running > + * @SYSTEM_HALT: system entered clean system halt state > + * @SYSTEM_POWER_OFF: system entered shutdown/clean power off state > + * @SYSTEM_RESTART: system entered emergency power off or normal restart > + * @SYSTEM_SUSPEND: system entered suspend or hibernate state > */ > extern enum system_states { > SYSTEM_BOOTING, >
--- linux-next-20241125.orig/include/linux/kernel.h +++ linux-next-20241125/include/linux/kernel.h @@ -176,9 +176,19 @@ extern int root_mountflags; extern bool early_boot_irqs_disabled; -/* - * Values used for system_state. Ordering of the states must not be changed +/** + * enum system_states - Values used for system_state. + * Ordering of the states must not be changed * as code checks for <, <=, >, >= STATE. + * + * @SYSTEM_BOOTING: %0, no init needed + * @SYSTEM_SCHEDULING: system is ready for scheduling; OK to use RCU + * @SYSTEM_FREEING_INITMEM: system is freeing all of initmem; almost running + * @SYSTEM_RUNNING: system is up and running + * @SYSTEM_HALT: system entered clean system halt state + * @SYSTEM_POWER_OFF: system entered shutdown/clean power off state + * @SYSTEM_RESTART: system entered emergency power off or normal restart + * @SYSTEM_SUSPEND: system entered suspend or hibernate state */ extern enum system_states { SYSTEM_BOOTING,
Provide some basic comments about the system_states and what they imply. Also convert the comments to kernel-doc format. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: "Rafael J. Wysocki" <rafael@kernel.org> Cc: Pavel Machek <pavel@ucw.cz> Cc: Len Brown <len.brown@intel.com> Cc: linux-pm@vger.kernel.org Cc: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com> --- include/linux/kernel.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)