platform_hardware_interfaces/health/storage/1.0/IStorage.hal
Yifan Hong ec75d33d9c health.filesystem::IFileSystem -> health.storage::IStorage
Rename the HAL because it is regarding 'storage health',
not 'filesystem health'.

Bug: 111655771
Test: compiles
Change-Id: I07072c876fb07c88be8bd74cf6b84aec6020a697
Merged-In: I07072c876fb07c88be8bd74cf6b84aec6020a697
2018-09-19 13:11:59 -07:00

49 lines
1.8 KiB
Text

/*
* Copyright (C) 2018 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.health.storage@1.0;
import IGarbageCollectCallback;
/**
* IStorage is an interface that provides operations on underlying storage
* devices, including flash memory.
*/
interface IStorage {
/**
* Start garbage collection on the driver of storage devices.
*
* Garbage collection must be started at regular intervals when it is a good
* time for a longer-running cleanup tasks, roughly daily.
*
* When garbage collection finishes or encounters an error before the
* specified timeout, the implementation must call IGarbageCollect.finish
* immediately with appropriate result.
*
* If garbage collection does not finish within the specified timeout,
* the implementation must stop garbage collection, and must not call
* IGarbageCollect.finish.
*
* @param timeoutSeconds timeout in seconds. The implementation must
* return after the timeout is reached.
*
* @param callback callback interface. Callback must be null if the client
* does not need to receive any callbacks.
*
*/
oneway garbageCollect(uint64_t timeoutSeconds,
IGarbageCollectCallback callback);
};