Sharvil Nanavati | 3cf59ef | 2014-04-09 22:20:40 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
Jakub Pawlowski | 5b790fe | 2017-09-18 09:00:20 -0700 | [diff] [blame] | 3 | * Copyright 2014 Google, Inc. |
Sharvil Nanavati | 3cf59ef | 2014-04-09 22:20:40 -0700 | [diff] [blame] | 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | * you may not use this file except in compliance with the License. |
| 7 | * You may obtain a copy of the License at: |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | * |
| 17 | ******************************************************************************/ |
| 18 | |
| 19 | #pragma once |
| 20 | |
Jakub Pawlowski | 819e2ec | 2017-07-10 09:56:09 -0700 | [diff] [blame] | 21 | #include <bluetooth/uuid.h> |
Chris Manton | 5c26224 | 2014-10-14 22:00:32 -0700 | [diff] [blame] | 22 | #include <hardware/bluetooth.h> |
Chris Manton | 97c5444 | 2015-01-07 13:34:18 -0800 | [diff] [blame] | 23 | #include <stdint.h> |
Chris Manton | 5c26224 | 2014-10-14 22:00:32 -0700 | [diff] [blame] | 24 | #include <stdlib.h> |
Sharvil Nanavati | 3cf59ef | 2014-04-09 22:20:40 -0700 | [diff] [blame] | 25 | |
Chris Manton | 97c5444 | 2015-01-07 13:34:18 -0800 | [diff] [blame] | 26 | #include "btcore/include/device_class.h" |
| 27 | |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 28 | // Copies an array of consecutive properties of |count| to a newly |
| 29 | // allocated array. |properties| must not be NULL. |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 30 | bt_property_t* property_copy_array(const bt_property_t* properties, |
| 31 | size_t count); |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 32 | |
| 33 | // Copies |src| to |dest|. Returns the value of |dest|. |
| 34 | // |src| and |dest| must not be NULL. |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 35 | bt_property_t* property_copy(bt_property_t* dest, const bt_property_t* src); |
Chris Manton | 97c5444 | 2015-01-07 13:34:18 -0800 | [diff] [blame] | 36 | |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 37 | // Returns true if the value of the two properties |p1| and |p2| are equal. |
| 38 | // |p1| and |p2| must not be NULL. |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 39 | bool property_equals(const bt_property_t* p1, const bt_property_t* p2); |
Sharvil Nanavati | 3cf59ef | 2014-04-09 22:20:40 -0700 | [diff] [blame] | 40 | |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 41 | // Property resource allocations. Caller is expected to free |property| |
| 42 | // using |property_free| or |property_free_array|. |
| 43 | // Parameter must not be NULL. A copy of the parameter is made and |
| 44 | // stored in the property. |
Jakub Pawlowski | a484a88 | 2017-06-24 17:30:18 -0700 | [diff] [blame] | 45 | bt_property_t* property_new_addr(const RawAddress* addr); |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 46 | bt_property_t* property_new_device_class(const bt_device_class_t* dc); |
| 47 | bt_property_t* property_new_device_type(bt_device_type_t device_type); |
| 48 | bt_property_t* property_new_discovery_timeout(const uint32_t timeout); |
| 49 | bt_property_t* property_new_name(const char* name); |
| 50 | bt_property_t* property_new_rssi(const int8_t rssi); |
| 51 | bt_property_t* property_new_scan_mode(bt_scan_mode_t scan_mode); |
Jakub Pawlowski | 819e2ec | 2017-07-10 09:56:09 -0700 | [diff] [blame] | 52 | bt_property_t* property_new_uuids(const bluetooth::Uuid* uuid, size_t count); |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 53 | |
| 54 | // Property resource frees both property and value. |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 55 | void property_free(bt_property_t* property); |
| 56 | void property_free_array(bt_property_t* properties, size_t count); |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 57 | |
| 58 | // Value check convenience methods. The contents of the property are |
| 59 | // checked for the respective validity and returns true, false otherwise. |
| 60 | // |property| must not be NULL. |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 61 | bool property_is_addr(const bt_property_t* property); |
| 62 | bool property_is_device_class(const bt_property_t* property); |
| 63 | bool property_is_device_type(const bt_property_t* property); |
| 64 | bool property_is_discovery_timeout(const bt_property_t* property); |
| 65 | bool property_is_name(const bt_property_t* property); |
| 66 | bool property_is_rssi(const bt_property_t* property); |
| 67 | bool property_is_scan_mode(const bt_property_t* property); |
| 68 | bool property_is_uuids(const bt_property_t* property); |
Chris Manton | 3252cf0 | 2015-01-08 10:47:59 -0800 | [diff] [blame] | 69 | |
| 70 | // Value conversion convenience methods. The contents of the property are |
| 71 | // properly typed and returned to the caller. |property| must not be NULL. |
Jakub Pawlowski | a484a88 | 2017-06-24 17:30:18 -0700 | [diff] [blame] | 72 | const RawAddress* property_as_addr(const bt_property_t* property); |
Myles Watson | 911d1ae | 2016-11-28 16:44:40 -0800 | [diff] [blame] | 73 | const bt_device_class_t* property_as_device_class( |
| 74 | const bt_property_t* property); |
| 75 | bt_device_type_t property_as_device_type(const bt_property_t* property); |
| 76 | uint32_t property_as_discovery_timeout(const bt_property_t* property); |
| 77 | const bt_bdname_t* property_as_name(const bt_property_t* property); |
| 78 | int8_t property_as_rssi(const bt_property_t* property); |
| 79 | bt_scan_mode_t property_as_scan_mode(const bt_property_t* property); |
Jakub Pawlowski | 819e2ec | 2017-07-10 09:56:09 -0700 | [diff] [blame] | 80 | const bluetooth::Uuid* property_as_uuids(const bt_property_t* property, |
| 81 | size_t* count); |