| #ifndef HIDL_GENERATED_ANDROID_HARDWARE_BROADCASTRADIO_V2_0_IBROADCASTRADIO_H |
| #define HIDL_GENERATED_ANDROID_HARDWARE_BROADCASTRADIO_V2_0_IBROADCASTRADIO_H |
| |
| #include <android/hardware/broadcastradio/2.0/IAnnouncementListener.h> |
| #include <android/hardware/broadcastradio/2.0/ICloseHandle.h> |
| #include <android/hardware/broadcastradio/2.0/ITunerCallback.h> |
| #include <android/hardware/broadcastradio/2.0/ITunerSession.h> |
| #include <android/hardware/broadcastradio/2.0/types.h> |
| #include <android/hidl/base/1.0/IBase.h> |
| |
| #include <android/hidl/manager/1.0/IServiceNotification.h> |
| |
| #include <hidl/HidlSupport.h> |
| #include <hidl/MQDescriptor.h> |
| #include <hidl/Status.h> |
| #include <utils/NativeHandle.h> |
| #include <utils/misc.h> |
| |
| namespace android { |
| namespace hardware { |
| namespace broadcastradio { |
| namespace V2_0 { |
| |
| /** |
| * Represents a hardware broadcast radio module. A single module may contain |
| * multiple hardware tuners (i.e. with an additional background tuner), but the |
| * layers above the HAL see them as a single logical unit. |
| */ |
| struct IBroadcastRadio : public ::android::hidl::base::V1_0::IBase { |
| /** |
| * Type tag for use in template logic that indicates this is a 'pure' class. |
| */ |
| typedef ::android::hardware::details::i_tag _hidl_tag; |
| |
| /** |
| * Fully qualified interface name: "android.hardware.broadcastradio@2.0::IBroadcastRadio" |
| */ |
| static const char* descriptor; |
| |
| /** |
| * Returns whether this object's implementation is outside of the current process. |
| */ |
| virtual bool isRemote() const override { return false; } |
| |
| /** |
| * Return callback for getProperties |
| */ |
| using getProperties_cb = std::function<void(const ::android::hardware::broadcastradio::V2_0::Properties& properties)>; |
| /** |
| * Returns module properties: a description of a module and its |
| * capabilities. This method must not fail. |
| * |
| * @return properties Module description. |
| */ |
| virtual ::android::hardware::Return<void> getProperties(getProperties_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for getAmFmRegionConfig |
| */ |
| using getAmFmRegionConfig_cb = std::function<void(::android::hardware::broadcastradio::V2_0::Result result, const ::android::hardware::broadcastradio::V2_0::AmFmRegionConfig& config)>; |
| /** |
| * Fetches current or possible AM/FM region configuration. |
| * |
| * @param full If true, returns full hardware capabilities. |
| * If false, returns current regional configuration. |
| * @return result OK in case of success. |
| * NOT_SUPPORTED if the tuner doesn't support AM/FM. |
| * @return config Hardware capabilities (full=true) or |
| * current configuration (full=false). |
| */ |
| virtual ::android::hardware::Return<void> getAmFmRegionConfig(bool full, getAmFmRegionConfig_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for getDabRegionConfig |
| */ |
| using getDabRegionConfig_cb = std::function<void(::android::hardware::broadcastradio::V2_0::Result result, const ::android::hardware::hidl_vec<::android::hardware::broadcastradio::V2_0::DabTableEntry>& config)>; |
| /** |
| * Fetches current DAB region configuration. |
| * |
| * @return result OK in case of success. |
| * NOT_SUPPORTED if the tuner doesn't support DAB. |
| * @return config Current configuration. |
| */ |
| virtual ::android::hardware::Return<void> getDabRegionConfig(getDabRegionConfig_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for openSession |
| */ |
| using openSession_cb = std::function<void(::android::hardware::broadcastradio::V2_0::Result result, const ::android::sp<::android::hardware::broadcastradio::V2_0::ITunerSession>& session)>; |
| /** |
| * Opens a new tuner session. |
| * |
| * There may be only one session active at a time. If the new session was |
| * requested when the old one was active, the old must be terminated |
| * (aggressive open). |
| * |
| * @param callback The callback interface. |
| * @return result OK in case of success. |
| * @return session The session interface. |
| */ |
| virtual ::android::hardware::Return<void> openSession(const ::android::sp<::android::hardware::broadcastradio::V2_0::ITunerCallback>& callback, openSession_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for getImage |
| */ |
| using getImage_cb = std::function<void(const ::android::hardware::hidl_vec<uint8_t>& image)>; |
| /** |
| * Fetch image from radio module cache. |
| * |
| * This is out-of-band transport mechanism for images carried with metadata. |
| * The metadata vector only passes the identifier, so the client may cache |
| * images or even not fetch them. |
| * |
| * The identifier may be any arbitrary number (i.e. sha256 prefix) selected |
| * by the vendor. It must be stable across sessions so the application may |
| * cache it. |
| * |
| * The data must be a valid PNG, JPEG, GIF or BMP file. |
| * Image data with an invalid format must be handled gracefully in the same |
| * way as a missing image. |
| * |
| * The image identifier may become invalid after some time from passing it |
| * with metadata struct (due to resource cleanup at the HAL implementation). |
| * However, it must remain valid for a currently tuned program at least |
| * until onCurrentProgramInfoChanged is called. |
| * |
| * There is still a race condition possible between |
| * onCurrentProgramInfoChanged callback and the HAL implementation eagerly |
| * clearing the cache (because the next onCurrentProgramInfoChanged came). |
| * In such case, client application may expect the new |
| * onCurrentProgramInfoChanged callback with updated image identifier. |
| * |
| * @param id Identifier of an image (value of Constants::INVALID_IMAGE is |
| * reserved and must be treated as invalid image). |
| * @return image A binary blob with image data |
| * or a zero-length vector if identifier doesn't exist. |
| */ |
| virtual ::android::hardware::Return<void> getImage(uint32_t id, getImage_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for registerAnnouncementListener |
| */ |
| using registerAnnouncementListener_cb = std::function<void(::android::hardware::broadcastradio::V2_0::Result result, const ::android::sp<::android::hardware::broadcastradio::V2_0::ICloseHandle>& closeHandle)>; |
| /** |
| * Registers announcement listener. |
| * |
| * If there is at least one observer registered, HAL implementation must |
| * notify about announcements even if no sessions are active. |
| * |
| * If the observer dies, the HAL implementation must unregister observer |
| * automatically. |
| * |
| * @param enabled The list of announcement types to watch for. |
| * @param listener The listener interface. |
| * @return result OK in case of success. |
| * NOT_SUPPORTED if the tuner doesn't support announcements. |
| * @return closeHandle A handle to unregister observer, |
| * nullptr if result was not OK. |
| */ |
| virtual ::android::hardware::Return<void> registerAnnouncementListener(const ::android::hardware::hidl_vec<::android::hardware::broadcastradio::V2_0::AnnouncementType>& enabled, const ::android::sp<::android::hardware::broadcastradio::V2_0::IAnnouncementListener>& listener, registerAnnouncementListener_cb _hidl_cb) = 0; |
| |
| /** |
| * Return callback for interfaceChain |
| */ |
| using interfaceChain_cb = std::function<void(const ::android::hardware::hidl_vec<::android::hardware::hidl_string>& descriptors)>; |
| /* |
| * Provides run-time type information for this object. |
| * For example, for the following interface definition: |
| * package android.hardware.foo@1.0; |
| * interface IParent {}; |
| * interface IChild extends IParent {}; |
| * Calling interfaceChain on an IChild object must yield the following: |
| * ["android.hardware.foo@1.0::IChild", |
| * "android.hardware.foo@1.0::IParent" |
| * "android.hidl.base@1.0::IBase"] |
| * |
| * @return descriptors a vector of descriptors of the run-time type of the |
| * object. |
| */ |
| virtual ::android::hardware::Return<void> interfaceChain(interfaceChain_cb _hidl_cb) override; |
| |
| /* |
| * Emit diagnostic information to the given file. |
| * |
| * Optionally overriden. |
| * |
| * @param fd File descriptor to dump data to. |
| * Must only be used for the duration of this call. |
| * @param options Arguments for debugging. |
| * Must support empty for default debug information. |
| */ |
| virtual ::android::hardware::Return<void> debug(const ::android::hardware::hidl_handle& fd, const ::android::hardware::hidl_vec<::android::hardware::hidl_string>& options) override; |
| |
| /** |
| * Return callback for interfaceDescriptor |
| */ |
| using interfaceDescriptor_cb = std::function<void(const ::android::hardware::hidl_string& descriptor)>; |
| /* |
| * Provides run-time type information for this object. |
| * For example, for the following interface definition: |
| * package android.hardware.foo@1.0; |
| * interface IParent {}; |
| * interface IChild extends IParent {}; |
| * Calling interfaceDescriptor on an IChild object must yield |
| * "android.hardware.foo@1.0::IChild" |
| * |
| * @return descriptor a descriptor of the run-time type of the |
| * object (the first element of the vector returned by |
| * interfaceChain()) |
| */ |
| virtual ::android::hardware::Return<void> interfaceDescriptor(interfaceDescriptor_cb _hidl_cb) override; |
| |
| /** |
| * Return callback for getHashChain |
| */ |
| using getHashChain_cb = std::function<void(const ::android::hardware::hidl_vec<::android::hardware::hidl_array<uint8_t, 32>>& hashchain)>; |
| /* |
| * Returns hashes of the source HAL files that define the interfaces of the |
| * runtime type information on the object. |
| * For example, for the following interface definition: |
| * package android.hardware.foo@1.0; |
| * interface IParent {}; |
| * interface IChild extends IParent {}; |
| * Calling interfaceChain on an IChild object must yield the following: |
| * [(hash of IChild.hal), |
| * (hash of IParent.hal) |
| * (hash of IBase.hal)]. |
| * |
| * SHA-256 is used as the hashing algorithm. Each hash has 32 bytes |
| * according to SHA-256 standard. |
| * |
| * @return hashchain a vector of SHA-1 digests |
| */ |
| virtual ::android::hardware::Return<void> getHashChain(getHashChain_cb _hidl_cb) override; |
| |
| /* |
| * This method trigger the interface to enable/disable instrumentation based |
| * on system property hal.instrumentation.enable. |
| */ |
| virtual ::android::hardware::Return<void> setHALInstrumentation() override; |
| |
| /* |
| * Registers a death recipient, to be called when the process hosting this |
| * interface dies. |
| * |
| * @param recipient a hidl_death_recipient callback object |
| * @param cookie a cookie that must be returned with the callback |
| * @return success whether the death recipient was registered successfully. |
| */ |
| virtual ::android::hardware::Return<bool> linkToDeath(const ::android::sp<::android::hardware::hidl_death_recipient>& recipient, uint64_t cookie) override; |
| |
| /* |
| * Provides way to determine if interface is running without requesting |
| * any functionality. |
| */ |
| virtual ::android::hardware::Return<void> ping() override; |
| |
| /** |
| * Return callback for getDebugInfo |
| */ |
| using getDebugInfo_cb = std::function<void(const ::android::hidl::base::V1_0::DebugInfo& info)>; |
| /* |
| * Get debug information on references on this interface. |
| * @return info debugging information. See comments of DebugInfo. |
| */ |
| virtual ::android::hardware::Return<void> getDebugInfo(getDebugInfo_cb _hidl_cb) override; |
| |
| /* |
| * This method notifies the interface that one or more system properties |
| * have changed. The default implementation calls |
| * (C++) report_sysprop_change() in libcutils or |
| * (Java) android.os.SystemProperties.reportSyspropChanged, |
| * which in turn calls a set of registered callbacks (eg to update trace |
| * tags). |
| */ |
| virtual ::android::hardware::Return<void> notifySyspropsChanged() override; |
| |
| /* |
| * Unregisters the registered death recipient. If this service was registered |
| * multiple times with the same exact death recipient, this unlinks the most |
| * recently registered one. |
| * |
| * @param recipient a previously registered hidl_death_recipient callback |
| * @return success whether the death recipient was unregistered successfully. |
| */ |
| virtual ::android::hardware::Return<bool> unlinkToDeath(const ::android::sp<::android::hardware::hidl_death_recipient>& recipient) override; |
| |
| // cast static functions |
| /** |
| * This performs a checked cast based on what the underlying implementation actually is. |
| */ |
| static ::android::hardware::Return<::android::sp<::android::hardware::broadcastradio::V2_0::IBroadcastRadio>> castFrom(const ::android::sp<::android::hardware::broadcastradio::V2_0::IBroadcastRadio>& parent, bool emitError = false); |
| /** |
| * This performs a checked cast based on what the underlying implementation actually is. |
| */ |
| static ::android::hardware::Return<::android::sp<::android::hardware::broadcastradio::V2_0::IBroadcastRadio>> castFrom(const ::android::sp<::android::hidl::base::V1_0::IBase>& parent, bool emitError = false); |
| |
| // helper methods for interactions with the hwservicemanager |
| /** |
| * This gets the service of this type with the specified instance name. If the |
| * service is currently not available or not in the VINTF manifest on a Trebilized |
| * device, this will return nullptr. This is useful when you don't want to block |
| * during device boot. If getStub is true, this will try to return an unwrapped |
| * passthrough implementation in the same process. This is useful when getting an |
| * implementation from the same partition/compilation group. |
| * |
| * In general, prefer getService(std::string,bool) |
| */ |
| static ::android::sp<IBroadcastRadio> tryGetService(const std::string &serviceName="default", bool getStub=false); |
| /** |
| * Deprecated. See tryGetService(std::string, bool) |
| */ |
| static ::android::sp<IBroadcastRadio> tryGetService(const char serviceName[], bool getStub=false) { std::string str(serviceName ? serviceName : ""); return tryGetService(str, getStub); } |
| /** |
| * Deprecated. See tryGetService(std::string, bool) |
| */ |
| static ::android::sp<IBroadcastRadio> tryGetService(const ::android::hardware::hidl_string& serviceName, bool getStub=false) { std::string str(serviceName.c_str()); return tryGetService(str, getStub); } |
| /** |
| * Calls tryGetService("default", bool). This is the recommended instance name for singleton services. |
| */ |
| static ::android::sp<IBroadcastRadio> tryGetService(bool getStub) { return tryGetService("default", getStub); } |
| /** |
| * This gets the service of this type with the specified instance name. If the |
| * service is not in the VINTF manifest on a Trebilized device, this will return |
| * nullptr. If the service is not available, this will wait for the service to |
| * become available. If the service is a lazy service, this will start the service |
| * and return when it becomes available. If getStub is true, this will try to |
| * return an unwrapped passthrough implementation in the same process. This is |
| * useful when getting an implementation from the same partition/compilation group. |
| */ |
| static ::android::sp<IBroadcastRadio> getService(const std::string &serviceName="default", bool getStub=false); |
| /** |
| * Deprecated. See getService(std::string, bool) |
| */ |
| static ::android::sp<IBroadcastRadio> getService(const char serviceName[], bool getStub=false) { std::string str(serviceName ? serviceName : ""); return getService(str, getStub); } |
| /** |
| * Deprecated. See getService(std::string, bool) |
| */ |
| static ::android::sp<IBroadcastRadio> getService(const ::android::hardware::hidl_string& serviceName, bool getStub=false) { std::string str(serviceName.c_str()); return getService(str, getStub); } |
| /** |
| * Calls getService("default", bool). This is the recommended instance name for singleton services. |
| */ |
| static ::android::sp<IBroadcastRadio> getService(bool getStub) { return getService("default", getStub); } |
| /** |
| * Registers a service with the service manager. For Trebilized devices, the service |
| * must also be in the VINTF manifest. |
| */ |
| __attribute__ ((warn_unused_result))::android::status_t registerAsService(const std::string &serviceName="default"); |
| /** |
| * Registers for notifications for when a service is registered. |
| */ |
| static bool registerForNotifications( |
| const std::string &serviceName, |
| const ::android::sp<::android::hidl::manager::V1_0::IServiceNotification> ¬ification); |
| }; |
| |
| // |
| // type declarations for package |
| // |
| |
| static inline std::string toString(const ::android::sp<::android::hardware::broadcastradio::V2_0::IBroadcastRadio>& o); |
| |
| // |
| // type header definitions for package |
| // |
| |
| static inline std::string toString(const ::android::sp<::android::hardware::broadcastradio::V2_0::IBroadcastRadio>& o) { |
| std::string os = "[class or subclass of "; |
| os += ::android::hardware::broadcastradio::V2_0::IBroadcastRadio::descriptor; |
| os += "]"; |
| os += o->isRemote() ? "@remote" : "@local"; |
| return os; |
| } |
| |
| |
| } // namespace V2_0 |
| } // namespace broadcastradio |
| } // namespace hardware |
| } // namespace android |
| |
| // |
| // global type declarations for package |
| // |
| |
| |
| #endif // HIDL_GENERATED_ANDROID_HARDWARE_BROADCASTRADIO_V2_0_IBROADCASTRADIO_H |