diff options
author | Alex Ray <aray@google.com> | 2013-09-04 23:32:14 -0700 |
---|---|---|
committer | Alex Ray <aray@google.com> | 2013-09-09 23:52:49 -0700 |
commit | fe46e6a90675fc637a1482e8dfeb27e374b7600d (patch) | |
tree | 5ae6cfba18757ae72adcc660669c2af9695b1d80 | |
parent | eb485256e99e97653773024951568aadcc60f6a4 (diff) | |
download | libhardware-fe46e6a90675fc637a1482e8dfeb27e374b7600d.tar.gz |
libhardware: add Consumer IR HAL API
Change-Id: I68db7911784aa802b378a5e1dad62397da16b03b
-rw-r--r-- | include/hardware/consumerir.h | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/include/hardware/consumerir.h b/include/hardware/consumerir.h new file mode 100644 index 00000000..14679438 --- /dev/null +++ b/include/hardware/consumerir.h @@ -0,0 +1,80 @@ +/* + * Copyright (C) 2013 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. + */ + +#ifndef ANDROID_INCLUDE_HARDWARE_CONSUMERIR_H +#define ANDROID_INCLUDE_HARDWARE_CONSUMERIR_H + +#include <stdint.h> +#include <sys/cdefs.h> +#include <hardware/hardware.h> +#include <hardware/hwcomposer_defs.h> + +#define CONSUMERIR_MODULE_API_VERSION_1_0 HARDWARE_MODULE_API_VERSION(1, 0) +#define CONSUMERIR_HARDWARE_MODULE_ID "consumerir" +#define CONSUMERIR_TRANSMITTER "transmitter" + +typedef struct consumerir_freq_range { + int min; + int max; +} consumerir_freq_range_t; + +typedef struct consumerir_module { + struct hw_module_t common; +} consumerir_module_t; + +typedef struct consumerir_device { + struct hw_device_t common; + + /* + * (*transmit)() is called to by the ConsumerIrService to send an IR pattern + * at a given carrier_freq. + * + * The pattern is alternating series of carrier on and off periods measured in + * microseconds. The carrier should be turned off at the end of a transmit + * even if there are and odd number of entries in the pattern array. + * + * This call should return when the transmit is complete or encounters an error. + * + * returns: 0 on success. A negative error code on error. + */ + int (*transmit)(struct consumerir_device *dev, int carrier_freq, + int pattern[], int pattern_len); + + /* + * (*get_num_carrier_freqs)() is called by the ConsumerIrService to get the + * number of carrier freqs to allocate space for, which is then filled by + * a subsequent call to (*get_carrier_freqs)(). + * + * returns: the number of ranges on success. A negative error code on error. + */ + int (*get_num_carrier_freqs)(struct consumerir_device *dev); + + /* + * (*get_carrier_freqs)() is called by the ConsumerIrService to enumerate + * which frequencies the IR transmitter supports. The HAL implementation + * should fill an array of consumerir_freq_range structs with the + * appropriate values for the transmitter. + * + * returns: the number of ranges on success. A negative error code on error. + */ + int (*get_carrier_freqs)(struct consumerir_device *dev, + consumerir_freq_range_t *ranges); + + /* Reserved for future use. Must be NULL. */ + void* reserved[8 - 3]; +} consumerir_device_t; + +#endif /* ANDROID_INCLUDE_HARDWARE_CONSUMERIR_H */ |