NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO
#include <ddm/ddm.h>KnError svDdmOffline(DevNode node);
The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.
See API(5FEA) for details.
DDM
The svDdmOffline() call enables the DDM client to set the run state of the specified node to DDM_RUNSTATE_OFFLINE. This means that a driver implementing the diagnostic DDI, diag(9DDI) should be made active for this node.
This call only applies if the device is currently in the DDM_RUNSTATE_INACTIVE state. The availability state of the device must first be set to DDM_AVSTATE_ENABLED so that the diagnostic driver can be started on the device.
This operation will only succeed if a diagnostic driver can be located for the device. Generally this type of driver is started during the boot sequence as the normal driver, though it adds a PROP_DIAG_DRIVER property to the device node. This enables the diagnostic driver, that is used to set the device to offline, to be located and started.
Upon completion K_OK is returned provided the status of the device was successfully set to offline. Otherwise, a negative error code is returned which indicates why the call was not successful.
The child_init driver management entry point detects that the driver property is set to PROP_ACTIVE
The specified node is not recognized as a manageable device
The state requested could not be set according to the current state of the device, or the node does not have a parent that exports the management DDI, or the current driver state is not set to DDM_RUNSTATE_INACTIVE (see mngt(9DDI)); This indicates a severe internal error.
The system is out of resources. This indicates a severe system error.
The operation is not supported
The offline state could not be set. This may occur, for example, if the diag driver did not initialize the device or if the diag driver does not have the same bus type as the device.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Evolving |
svDdmOpen(2K), svDdmClose(2K), svDdmGetState(2K), , svDdmEnable(2K), svDdmDisable(2K), svDdmShutdown(2K), svDdmOnline(2K), svDdmGetStats(2K), svDdmAudit(2K), svDdmDiag(2K), svDdmGetInfo(2K), DDM(5FEA)
NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO