xref: /btstack/port/stm32-wb55xx-nucleo-freertos/Middlewares/STM32_WPAN/ble/core/auto/ble_l2cap_aci.h (revision 0561b2d8d5dba972c7daa57d5e677f7a1327edfd)
1 /******************************************************************************
2  * @file    ble_l2cap_aci.h
3  * @author  MCD Application Team
4  * @date    23 May 2019
5  * @brief   Header file for STM32WB (l2cap_aci)
6  *          Auto-generated file: do not edit!
7  ******************************************************************************
8  * @attention
9  *
10  * <h2><center>&copy; Copyright (c) 2019 STMicroelectronics.
11  * All rights reserved.</center></h2>
12  *
13  * This software component is licensed by ST under Ultimate Liberty license
14  * SLA0044, the "License"; You may not use this file except in compliance with
15  * the License. You may obtain a copy of the License at:
16  *                             www.st.com/SLA0044
17  *
18  ******************************************************************************
19  */
20 
21 #ifndef BLE_L2CAP_ACI_H__
22 #define BLE_L2CAP_ACI_H__
23 
24 
25 #include "ble_types.h"
26 
27 /**
28   * @brief Send an L2CAP connection parameter update request from the slave to the master.
29 An @ref aci_l2cap_connection_update_resp_event event will be raised when the master will respond to the
30 request (accepts or rejects).
31   * @param Connection_Handle Connection handle for which the command is given.
32   * Values:
33   - 0x0000 ... 0x0EFF
34   * @param Conn_Interval_Min Minimum value for the connection event interval. This shall be less
35 than or equal to Conn_Interval_Max.
36 Time = N * 1.25 msec.
37   * Values:
38   - 0x0006 (7.50 ms)  ... 0x0C80 (4000.00 ms)
39   * @param Conn_Interval_Max Maximum value for the connection event interval. This shall be
40 greater than or equal to Conn_Interval_Min.
41 Time = N * 1.25 msec.
42   * Values:
43   - 0x0006 (7.50 ms)  ... 0x0C80 (4000.00 ms)
44   * @param Slave_latency Slave latency for the connection in number of connection events.
45   * Values:
46   - 0x0000 ... 0x01F3
47   * @param Timeout_Multiplier Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms.
48   * @retval Value indicating success or error code.
49 */
50 tBleStatus aci_l2cap_connection_parameter_update_req(uint16_t Connection_Handle,
51                                                      uint16_t Conn_Interval_Min,
52                                                      uint16_t Conn_Interval_Max,
53                                                      uint16_t Slave_latency,
54                                                      uint16_t Timeout_Multiplier);
55 
56 /**
57   * @brief Accept or reject a connection update. This command should be sent in response
58 to a @ref aci_l2cap_connection_update_req_event event from the controller. The accept parameter has to be
59 set if the connection parameters given in the event are acceptable.
60   * @param Connection_Handle Connection handle for which the command is given.
61   * Values:
62   - 0x0000 ... 0x0EFF
63   * @param Conn_Interval_Min Minimum value for the connection event interval. This shall be less
64 than or equal to Conn_Interval_Max.
65 Time = N * 1.25 msec.
66   * Values:
67   - 0x0006 (7.50 ms)  ... 0x0C80 (4000.00 ms)
68   * @param Conn_Interval_Max Maximum value for the connection event interval. This shall be
69 greater than or equal to Conn_Interval_Min.
70 Time = N * 1.25 msec.
71   * Values:
72   - 0x0006 (7.50 ms)  ... 0x0C80 (4000.00 ms)
73   * @param Slave_latency Slave latency for the connection in number of connection events.
74   * Values:
75   - 0x0000 ... 0x01F3
76   * @param Timeout_Multiplier Defines connection timeout parameter in the following manner: Timeout Multiplier * 10ms.
77   * @param Minimum_CE_Length Information parameter about the minimum length of connection
78 needed for this LE connection.
79 Time = N * 0.625 msec.
80   * Values:
81   - 0x0000 (0.000 ms)  ... 0xFFFF (40959.375 ms)
82   * @param Maximum_CE_Length Information parameter about the maximum length of connection needed
83 for this LE connection.
84 Time = N * 0.625 msec.
85   * Values:
86   - 0x0000 (0.000 ms)  ... 0xFFFF (40959.375 ms)
87   * @param Identifier Identifier received in ACI_L2CAP_Connection_Update_Req event.
88   * @param Accept Specify if connection update parameters are acceptable or not.
89   * Values:
90   - 0x00: Reject
91   - 0x01: Accept
92   * @retval Value indicating success or error code.
93 */
94 tBleStatus aci_l2cap_connection_parameter_update_resp(uint16_t Connection_Handle,
95                                                       uint16_t Conn_Interval_Min,
96                                                       uint16_t Conn_Interval_Max,
97                                                       uint16_t Slave_latency,
98                                                       uint16_t Timeout_Multiplier,
99                                                       uint16_t Minimum_CE_Length,
100                                                       uint16_t Maximum_CE_Length,
101                                                       uint8_t Identifier,
102                                                       uint8_t Accept);
103 
104 /**
105      * @}
106      */
107 
108 #endif /* ! BLE_L2CAP_ACI_H__ */
109