Google Git
Sign in
apache / mynewt-nimble / refs/heads/master / . / nimble / host / src / ble_att_cmd_priv.h
blob: 78c60d5ef495a1907f6da1dadc41a65da76db45a [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 H_BLE_ATT_CMD_
#define H_BLE_ATT_CMD_
#include <inttypes.h>
#include <stddef.h>
#include "os/os_mbuf.h"
#ifdef __cplusplus
extern "C" {
#endif
struct ble_att_hdr {
uint8_t opcode;
uint8_t data[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Request Opcode In Error | 1 |
* | Attribute Handle In Error | 2 |
* | Error Code | 1 |
*/
#define BLE_ATT_ERROR_RSP_SZ 5
struct ble_att_error_rsp {
uint8_t baep_req_op;
uint16_t baep_handle;
uint8_t baep_error_code;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Server Rx MTU | 2 |
*/
#define BLE_ATT_MTU_CMD_SZ 3
struct ble_att_mtu_cmd {
uint16_t bamc_mtu;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Starting Handle | 2 |
* | Ending Handle | 2 |
*/
#define BLE_ATT_FIND_INFO_REQ_SZ 5
struct ble_att_find_info_req {
uint16_t bafq_start_handle;
uint16_t bafq_end_handle;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Format | 1 |
* | Information Data | 4 to (ATT_MTU-2) |
*/
#define BLE_ATT_FIND_INFO_RSP_BASE_SZ 2
struct ble_att_find_info_rsp {
uint8_t bafp_format;
/* Followed by information data. */
} __attribute__((packed));
#define BLE_ATT_FIND_INFO_RSP_FORMAT_16BIT 1
#define BLE_ATT_FIND_INFO_RSP_FORMAT_128BIT 2
#define BLE_ATT_FIND_INFO_IDATA_16_SZ 4
#define BLE_ATT_FIND_INFO_IDATA_128_SZ 18
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Starting Handle | 2 |
* | Ending Handle | 2 |
* | Attribute Type | 2 |
* | Attribute Value | 0 to (ATT_MTU-7) |
*/
#define BLE_ATT_FIND_TYPE_VALUE_REQ_BASE_SZ 7
struct ble_att_find_type_value_req {
uint16_t bavq_start_handle;
uint16_t bavq_end_handle;
uint16_t bavq_attr_type;
uint16_t bavq_value[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Information Data | 4 to (ATT_MTU-1) |
*/
#define BLE_ATT_FIND_TYPE_VALUE_RSP_BASE_SZ 1
#define BLE_ATT_FIND_TYPE_VALUE_HINFO_BASE_SZ 4
struct ble_att_handle_group {
uint16_t attr_handle;
uint16_t group_end_handle;
} __attribute__((packed));
struct ble_att_find_type_value_rsp {
struct ble_att_handle_group list[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Starting Handle | 2 |
* | Ending Handle | 2 |
* | Attribute Type | 2 or 16 |
*/
#define BLE_ATT_READ_TYPE_REQ_BASE_SZ 5
#define BLE_ATT_READ_TYPE_REQ_SZ_16 7
#define BLE_ATT_READ_TYPE_REQ_SZ_128 21
struct ble_att_read_type_req {
uint16_t batq_start_handle;
uint16_t batq_end_handle;
uint8_t uuid[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Length | 1 |
* | Attribute Data List | 2 to (ATT_MTU-2) |
*/
#define BLE_ATT_READ_TYPE_RSP_BASE_SZ 2
struct ble_att_attr_data_list {
uint16_t handle;
uint8_t value[0];
} __attribute__((packed));
struct ble_att_read_type_rsp {
uint8_t batp_length;
struct ble_att_attr_data_list batp_list[0];
} __attribute__((packed));
#define BLE_ATT_READ_TYPE_ADATA_BASE_SZ 2
#define BLE_ATT_READ_TYPE_ADATA_SZ_16 6
#define BLE_ATT_READ_TYPE_ADATA_SZ_128 20
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
*/
#define BLE_ATT_READ_REQ_SZ 3
struct ble_att_read_req {
uint16_t barq_handle;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Value | 0 to (ATT_MTU-1) |
*/
#define BLE_ATT_READ_RSP_BASE_SZ 1
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
* | Value Offset | 2 |
*/
#define BLE_ATT_READ_BLOB_REQ_SZ 5
struct ble_att_read_blob_req {
uint16_t babq_handle;
uint16_t babq_offset;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Value | 0 to (ATT_MTU-1) |
*/
#define BLE_ATT_READ_BLOB_RSP_BASE_SZ 1
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Set Of Handles | 4 to (ATT_MTU-1) |
*/
#define BLE_ATT_READ_MULT_REQ_BASE_SZ 1
struct ble_att_read_mult_req {
uint16_t handles[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Set Of Values | 4 to (ATT_MTU-1) |
*/
#define BLE_ATT_READ_MULT_RSP_BASE_SZ 1
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Starting Handle | 2 |
* | Ending Handle | 2 |
* | Attribute Group Type | 2 or 16 |
*/
#define BLE_ATT_READ_GROUP_TYPE_REQ_BASE_SZ 5
#define BLE_ATT_READ_GROUP_TYPE_REQ_SZ_16 7
#define BLE_ATT_READ_GROUP_TYPE_REQ_SZ_128 21
struct ble_att_read_group_type_req {
uint16_t bagq_start_handle;
uint16_t bagq_end_handle;
uint8_t uuid[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Length | 1 |
* | Attribute Data List | 2 to (ATT_MTU-2) |
*/
#define BLE_ATT_READ_GROUP_TYPE_RSP_BASE_SZ 2
struct ble_att_read_group_type_rsp {
uint8_t bagp_length;
} __attribute__((packed));
#define BLE_ATT_READ_GROUP_TYPE_ADATA_BASE_SZ 4
#define BLE_ATT_READ_GROUP_TYPE_ADATA_SZ_16 6
#define BLE_ATT_READ_GROUP_TYPE_ADATA_SZ_128 20
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
* | Attribute Value | 0 to (ATT_MTU-3) |
*/
#define BLE_ATT_WRITE_REQ_BASE_SZ 3
struct ble_att_write_req {
uint16_t bawq_handle;
uint8_t value[0];
} __attribute__((packed));
#define BLE_ATT_WRITE_RSP_SZ 1
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
* | Value Offset | 2 |
* | Part Attribute Value | 0 to (ATT_MTU-5) |
*/
#define BLE_ATT_PREP_WRITE_CMD_BASE_SZ 5
struct ble_att_prep_write_cmd {
uint16_t bapc_handle;
uint16_t bapc_offset;
uint16_t bapc_value[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Flags | 1 |
*/
#define BLE_ATT_EXEC_WRITE_REQ_SZ 2
struct ble_att_exec_write_req {
uint8_t baeq_flags;
} __attribute__((packed));
#define BLE_ATT_EXEC_WRITE_F_CANCEL 0x00
#define BLE_ATT_EXEC_WRITE_F_EXECUTE 0x01
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
*/
#define BLE_ATT_EXEC_WRITE_RSP_SZ 1
/**
* | Parameter | Size (octets) |
* +-----------------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle Length Value Tuple List | 8 to (ATT_MTU-1) |
*/
#define BLE_ATT_NOTIFY_MULTI_REQ_BASE_SZ 9
struct ble_att_tuple_list {
uint16_t handle;
uint16_t value_len;
uint8_t data[0];
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
* | Attribute Value | 0 to (ATT_MTU-3) |
*/
#define BLE_ATT_NOTIFY_REQ_BASE_SZ 3
struct ble_att_notify_req {
uint16_t banq_handle;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
* | Attribute Value | 0 to (ATT_MTU-3) |
*/
#define BLE_ATT_INDICATE_REQ_BASE_SZ 3
struct ble_att_indicate_req {
uint16_t baiq_handle;
} __attribute__((packed));
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
*/
#define BLE_ATT_INDICATE_RSP_SZ 1
/**
* | Parameter | Size (octets) |
* +------------------------------------+-------------------+
* | Attribute Opcode | 1 |
* | Attribute Handle | 2 |
* | Attribute Value | 0 to (ATT_MTU-3) |
*/
#define BLE_ATT_WRITE_CMD_BASE_SZ 3
struct ble_att_write_cmd {
uint16_t handle;
uint8_t value[0];
} __attribute__((packed));
void ble_att_error_rsp_parse(const void *payload, int len,
struct ble_att_error_rsp *rsp);
void ble_att_error_rsp_write(void *payload, int len,
const struct ble_att_error_rsp *rsp);
void ble_att_mtu_req_parse(const void *payload, int len,
struct ble_att_mtu_cmd *cmd);
void ble_att_mtu_req_write(void *payload, int len,
const struct ble_att_mtu_cmd *cmd);
void ble_att_mtu_rsp_parse(const void *payload, int len,
struct ble_att_mtu_cmd *cmd);
void ble_att_mtu_rsp_write(void *payload, int len,
const struct ble_att_mtu_cmd *cmd);
void ble_att_find_info_req_parse(const void *payload, int len,
struct ble_att_find_info_req *req);
void ble_att_find_info_req_write(void *payload, int len,
const struct ble_att_find_info_req *req);
void ble_att_find_info_rsp_parse(const void *payload, int len,
struct ble_att_find_info_rsp *rsp);
void ble_att_find_info_rsp_write(void *payload, int len,
const struct ble_att_find_info_rsp *rsp);
void ble_att_find_type_value_req_parse(
const void *payload, int len, struct ble_att_find_type_value_req *req);
void ble_att_find_type_value_req_write(
void *payload, int len, const struct ble_att_find_type_value_req *req);
void ble_att_read_type_req_parse(const void *payload, int len,
struct ble_att_read_type_req *req);
void ble_att_read_type_req_write(void *payload, int len,
const struct ble_att_read_type_req *req);
void ble_att_read_type_rsp_parse(const void *payload, int len,
struct ble_att_read_type_rsp *rsp);
void ble_att_read_type_rsp_write(void *payload, int len,
const struct ble_att_read_type_rsp *rsp);
void ble_att_read_req_parse(const void *payload, int len,
struct ble_att_read_req *req);
void ble_att_read_req_write(void *payload, int len,
const struct ble_att_read_req *req);
void ble_att_read_blob_req_parse(const void *payload, int len,
struct ble_att_read_blob_req *req);
void ble_att_read_blob_req_write(void *payload, int len,
const struct ble_att_read_blob_req *req);
void ble_att_read_mult_req_parse(const void *payload, int len);
void ble_att_read_mult_req_write(void *payload, int len);
void ble_att_read_mult_rsp_parse(const void *payload, int len);
void ble_att_read_mult_rsp_write(void *payload, int len);
void ble_att_read_group_type_req_parse(
const void *payload, int len, struct ble_att_read_group_type_req *req);
void ble_att_read_group_type_req_write(
void *payload, int len, const struct ble_att_read_group_type_req *req);
void ble_att_read_group_type_rsp_parse(
const void *payload, int len, struct ble_att_read_group_type_rsp *rsp);
void ble_att_read_group_type_rsp_write(
void *payload, int len, const struct ble_att_read_group_type_rsp *rsp);
void ble_att_write_req_parse(const void *payload, int len,
struct ble_att_write_req *req);
void ble_att_write_req_write(void *payload, int len,
const struct ble_att_write_req *req);
void ble_att_write_cmd_parse(const void *payload, int len,
struct ble_att_write_req *req);
void ble_att_write_cmd_write(void *payload, int len,
const struct ble_att_write_req *req);
void ble_att_prep_write_req_parse(const void *payload, int len,
struct ble_att_prep_write_cmd *cmd);
void ble_att_prep_write_req_write(void *payload, int len,
const struct ble_att_prep_write_cmd *cmd);
void ble_att_prep_write_rsp_parse(const void *payload, int len,
struct ble_att_prep_write_cmd *cmd);
void ble_att_prep_write_rsp_write(void *payload, int len,
const struct ble_att_prep_write_cmd *cmd);
void ble_att_exec_write_req_parse(const void *payload, int len,
struct ble_att_exec_write_req *req);
void ble_att_exec_write_req_write(void *payload, int len,
const struct ble_att_exec_write_req *req);
void ble_att_exec_write_rsp_parse(const void *payload, int len);
void ble_att_exec_write_rsp_write(void *payload, int len);
void ble_att_notify_req_parse(const void *payload, int len,
struct ble_att_notify_req *req);
void ble_att_notify_req_write(void *payload, int len,
const struct ble_att_notify_req *req);
void ble_att_indicate_req_parse(const void *payload, int len,
struct ble_att_indicate_req *req);
void ble_att_indicate_req_write(void *payload, int len,
const struct ble_att_indicate_req *req);
void ble_att_indicate_rsp_parse(const void *payload, int len);
void ble_att_indicate_rsp_write(void *payload, int len);
void *ble_att_cmd_prepare(uint8_t opcode, size_t len, struct os_mbuf *txom);
void *ble_att_cmd_get(uint8_t opcode, size_t len, struct os_mbuf **txom);
int ble_att_tx(uint16_t conn_handle, uint16_t cid, struct os_mbuf *txom);
struct ble_l2cap_chan;
struct ble_hs_conn;
int ble_att_tx_with_conn(struct ble_hs_conn *conn, struct ble_l2cap_chan *chan,
struct os_mbuf *txom);
bool ble_att_is_response_op(uint8_t opcode);
bool ble_att_is_request_op(uint8_t opcode);
#ifdef __cplusplus
}
#endif
#endif