mirror of
https://github.com/Evolution-X/hardware_interfaces
synced 2026-02-01 10:44:41 +00:00
6e278a3798
- Return a DumpstateStatus from dumpstateBoard_1_1 - Better toggle API surface: set/getDeviceLoggingEnabled - Improved testing to allow for unsupported DumpstateMode values Bug: 143183758 Bug: 143184495 Test: atest VtsHalDumpstateV1_1TargetTest Change-Id: I505c2a790dc28ddce9b6f5b674394ef65b31c80c
72 lines
3.4 KiB
Plaintext
72 lines
3.4 KiB
Plaintext
/*
|
|
* Copyright (C) 2020 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package android.hardware.dumpstate@1.1;
|
|
|
|
import @1.0::IDumpstateDevice;
|
|
|
|
interface IDumpstateDevice extends @1.0::IDumpstateDevice {
|
|
/**
|
|
* Extension of dumpstateBoard which also accepts a mode parameter to limit dumped data.
|
|
*
|
|
* For an example of when this is relevant, consider a bug report being generated with
|
|
* DumpstateMode::CONNECTIVITY - there is no reason to include camera or USB logs in this type
|
|
* of report.
|
|
*
|
|
* The 1.0 version of #dumpstateBoard(handle) should just delegate to this new method and pass
|
|
* DumpstateMode::DEFAULT and a timeout of 30,000ms (30 seconds).
|
|
*
|
|
* This method may still be called by the dumpstate routine even if getDeviceLoggingEnabled
|
|
* returns false. In this case, it must return DumpstateStatus::DEVICE_LOGGING_NOT_ENABLED.
|
|
*
|
|
* @param h A native handle with one or two valid file descriptors. The first FD is for text
|
|
* output, the second (if present) is for binary output.
|
|
* @param mode A mode value to restrict dumped content.
|
|
* @param timeoutMillis An approximate "budget" for how much time this call has been allotted.
|
|
* If execution runs longer than this, the IDumpstateDevice service may be killed and only
|
|
* partial information will be included in the report.
|
|
* @return status A DumpstateStatus value indicating the final result.
|
|
*/
|
|
dumpstateBoard_1_1(handle h, DumpstateMode mode, uint64_t timeoutMillis)
|
|
generates (DumpstateStatus status);
|
|
|
|
/**
|
|
* Turns device vendor logging on or off.
|
|
*
|
|
* The setting should be persistent across reboots. Underlying implementations may need to start
|
|
* vendor logging daemons, set system properties, or change logging masks, for example. Given
|
|
* that many vendor logs contain significant amounts of private information and may come with
|
|
* memory/storage/battery impacts, calling this method on a user build should only be done after
|
|
* user consent has been obtained, e.g. from a toggle in developer settings.
|
|
*
|
|
* Even if device logging has been disabled, dumpstateBoard may still be called by the dumpstate
|
|
* routine. In this case, it must return DumpstateStatus::DEVICE_LOGGING_NOT_ENABLED.
|
|
*
|
|
* @param enable Whether to enable or disable device vendor logging.
|
|
*/
|
|
setDeviceLoggingEnabled(bool enable);
|
|
|
|
/**
|
|
* Queries the current state of device logging. Primarily for UI and informative purposes.
|
|
*
|
|
* Even if device logging has been disabled, dumpstateBoard may still be called by the dumpstate
|
|
* routine. In this case, it must return DumpstateStatus::DEVICE_LOGGING_NOT_ENABLED.
|
|
*
|
|
* @return enabled Whether or not vendor logging is currently enabled.
|
|
*/
|
|
getDeviceLoggingEnabled() generates (bool enabled);
|
|
};
|