1/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.graphics.allocator@2.0;
18
19import android.hardware.graphics.mapper@2.0;
20
21interface IAllocator {
22    /**
23     * Retrieves implementation-defined debug information, which will be
24     * displayed during, for example, `dumpsys SurfaceFlinger`.
25     *
26     * @return debugInfo is a string of debug information.
27     */
28    @entry
29    @exit
30    @callflow(next="*")
31    dumpDebugInfo() generates (string debugInfo);
32
33    /**
34     * Allocates buffers with the properties specified by the descriptor.
35     *
36     * @param descriptor specifies the properties of the buffers to allocate.
37     * @param count is the number of buffers to allocate.
38     * @return error is NONE upon success. Otherwise,
39     *         BAD_DESCRIPTOR when the descriptor is invalid.
40     *         NO_RESOURCES when the allocation cannot be fulfilled at this
41     *                      time.
42     *         UNSUPPORTED when any of the property encoded in the descriptor
43     *                     is not supported.
44     * @return stride is the number of pixels between two consecutive rows of
45     *         the buffers, when the concept of consecutive rows is defined.
46     *         Otherwise, it has no meaning.
47     * @return buffers is an array of raw handles to the newly allocated
48     *         buffers.
49     */
50    @entry
51    @exit
52    @callflow(next="*")
53    allocate(BufferDescriptor descriptor, uint32_t count)
54        generates (Error error,
55                   uint32_t stride,
56                   vec<handle> buffers);
57};
58