xref: /nrf52832-nimble/packages/NimBLE-latest/nimble/host/util/include/host/util/util.h (revision 042d53a763ad75cb1465103098bb88c245d95138)
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements.  See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership.  The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License.  You may obtain a copy of the License at
9  *
10  *  http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied.  See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
20 #ifndef H_HOST_UTIL_
21 #define H_HOST_UTIL_
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /**
28  * Tries to configure the device with at least one Bluetooth address.
29  * Addresses are restored in a hardware-specific fashion.
30  *
31  * @param prefer_random         Whether to attempt to restore a random address
32  *                                  before checking if a public address has
33  *                                  already been configured.
34  *
35  * @return                      0 on success;
36  *                              BLE_HS_ENOADDR if the device does not have any
37  *                                  available addresses.
38  *                              Other BLE host core code on error.
39  */
40 int ble_hs_util_ensure_addr(int prefer_random);
41 
42 #ifdef __cplusplus
43 }
44 #endif
45 
46 #endif
47