p71924506
/
linux_old1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

dcdbas.txt: standardize document format 

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Mark titles;
- Mark literal blocks;
- Mark table.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2017-05-17 11:59:38 -03:00 committed by Jonathan Corbet
parent 2e4e6f30f7
commit 7effa5b0e8
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Documentation/dcdbas.txt
View File

@ -1,4 +1,9 @@
===================================
Dell Systems Management Base Driver
===================================
Overview Overview
========
The Dell Systems Management Base Driver provides a sysfs interface for The Dell Systems Management Base Driver provides a sysfs interface for
systems management software such as Dell OpenManage to perform system systems management software such as Dell OpenManage to perform system
@ -17,6 +22,7 @@ more information about the libsmbios project.
System Management Interrupt System Management Interrupt
===========================
On some Dell systems, systems management software must access certain On some Dell systems, systems management software must access certain
management information via a system management interrupt (SMI). The SMI data management information via a system management interrupt (SMI). The SMI data
@ -24,12 +30,12 @@ buffer must reside in 32-bit address space, and the physical address of the
buffer is required for the SMI. The driver maintains the memory required for buffer is required for the SMI. The driver maintains the memory required for
the SMI and provides a way for the application to generate the SMI. the SMI and provides a way for the application to generate the SMI.
The driver creates the following sysfs entries for systems management The driver creates the following sysfs entries for systems management
software to perform these system management interrupts: software to perform these system management interrupts::
/sys/devices/platform/dcdbas/smi_data /sys/devices/platform/dcdbas/smi_data
/sys/devices/platform/dcdbas/smi_data_buf_phys_addr /sys/devices/platform/dcdbas/smi_data_buf_phys_addr
/sys/devices/platform/dcdbas/smi_data_buf_size /sys/devices/platform/dcdbas/smi_data_buf_size
/sys/devices/platform/dcdbas/smi_request /sys/devices/platform/dcdbas/smi_request
Systems management software must perform the following steps to execute Systems management software must perform the following steps to execute
a SMI using this driver: a SMI using this driver:
@ -43,6 +49,7 @@ a SMI using this driver:
Host Control Action Host Control Action
===================
Dell OpenManage supports a host control feature that allows the administrator Dell OpenManage supports a host control feature that allows the administrator
to perform a power cycle or power off of the system after the OS has finished to perform a power cycle or power off of the system after the OS has finished
@ -69,12 +76,14 @@ power off host control action using this driver:
Host Control SMI Type Host Control SMI Type
=====================
The following table shows the value to write to host_control_smi_type to The following table shows the value to write to host_control_smi_type to
perform a power cycle or power off host control action: perform a power cycle or power off host control action:
=================== =====================
PowerEdge System Host Control SMI Type PowerEdge System Host Control SMI Type
---------------- --------------------- =================== =====================
300 HC_SMITYPE_TYPE1 300 HC_SMITYPE_TYPE1
1300 HC_SMITYPE_TYPE1 1300 HC_SMITYPE_TYPE1
1400 HC_SMITYPE_TYPE2 1400 HC_SMITYPE_TYPE2
@ -87,5 +96,4 @@ PowerEdge System Host Control SMI Type
1655MC HC_SMITYPE_TYPE2 1655MC HC_SMITYPE_TYPE2
700 HC_SMITYPE_TYPE3 700 HC_SMITYPE_TYPE3
750 HC_SMITYPE_TYPE3 750 HC_SMITYPE_TYPE3
=================== =====================