xref: /aosp_15_r20/hardware/interfaces/broadcastradio/1.0/IBroadcastRadioFactory.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 2016 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 [email protected];

import IBroadcastRadio;

interface IBroadcastRadioFactory {

    /**
     * Connects to a broadcast radio HAL module for a given class
     * (AM/FM, Satellite, DAB).
     *
     * @param classId Class of the module to connect to .
     * @return retval operation completion status. Returns INVALID_ARGUMENTS
     *         if there is no corresponding hardware module found,
     *         NOT_INITIALIZED if an error occurred while opening the hardware
     *         module.
     * @return result the interface for the created module.
     */
    connectModule(Class classId)
      generates (Result retval, IBroadcastRadio result);
};