| #ifndef _GATT_H_ |
| #define _GATT_H_ |
| |
| #include "types.h" |
| #include "uuid.h" |
| #include "uniq.h" |
| #include "att.h" |
| #include "sg.h" |
| |
| |
| |
| typedef uniq_t gatt_service_t; |
| typedef uniq_t gatt_client_t; |
| typedef uniq_t gatt_client_conn_t; |
| |
| |
| #define GATTHANDLEFMT UNIQ_FMT"x" |
| #define GATTHANDLECNV(x) UNIQ_CONV(x) |
| |
| |
| #define GATT_PSM 0x001F |
| #define GATT_FIXEDCH 0x0004 |
| |
| |
| /* UUIDs & other GATT defines */ |
| #define GATT_UUID_SVC_GAP 0x1800 |
| #define GATT_UUID_SVC_GATT_SVR 0x1801 |
| #define GATT_UUID_SVC_PRIMARY 0x2800 |
| #define GATT_UUID_SVC_SECONDARY 0x2801 |
| #define GATT_UUID_INCLUDE 0x2802 |
| #define GATT_UUID_CHARACTERISTIC 0x2803 |
| #define GATT_UUID_CHAR_EXTD_PROPS 0x2900 |
| #define GATT_UUID_CHAR_USER_DESCR 0x2901 |
| #define GATT_UUID_CHAR_CLI_CHAR_CFG 0x2902 /* uint16_t, see GATT_CLI_CFG_BIT_* */ |
| #define GATT_UUID_CHAR_SVR_CHAR_CFG 0x2903 |
| #define GATT_UUID_CHAR_PRES_FMT 0x2904 |
| #define GATT_UUID_CHAR_AGGR_FMT 0x2905 |
| |
| #define GATT_CLI_CFG_BIT_NOTIFS 0x0001 |
| #define GATT_CLI_CFG_BIT_INDS 0x0002 |
| |
| /* what other device sees */ |
| #define GATT_PROP_BROADCAST 0x01 |
| #define GATT_PROP_READ 0x02 |
| #define GATT_PROP_WRITE_NO_RSP 0x04 |
| #define GATT_PROP_WRITE 0x08 |
| #define GATT_PROP_NOTIFY 0x10 |
| #define GATT_PROP_INDICATE 0x20 |
| #define GATT_PROP_AUTH_SIG_WRITE 0x40 |
| #define GATT_PROP_EXTD_PROPS 0x80 |
| |
| /* what we enforce */ |
| #define GATT_PERM_READ 0x00000001 |
| #define GATT_PERM_READ_ENCR 0x00000002 |
| #define GATT_PERM_READ_ENCR_MITM 0x00000004 |
| #define GATT_PERM_WRITE 0x00000010 |
| #define GATT_PERM_WRITE_ENCR 0x00000020 |
| #define GATT_PERM_WRITE_ENCR_MITM 0x00000040 |
| #define GATT_PERM_WRITE_SIGNED 0x00000080 |
| #define GATT_PERM_WRITE_SIGNED_MITM 0x00000100 |
| #define GATT_PERM_ALL_READ (GATT_PERM_READ | GATT_PERM_READ_ENCR | GATT_PERM_READ_ENCR_MITM) |
| #define GATT_PERM_ALL_WRITE (GATT_PERM_WRITE | GATT_PERM_WRITE_ENCR | GATT_PERM_WRITE_ENCR_MITM | GATT_PERM_WRITE_SIGNED | GATT_PERM_WRITE_SIGNED_MITM) |
| |
| |
| /* ==== GATT SERVER CODE (AKA PERIPHERAL MODE) ==== */ |
| |
| /* profile init/deinit */ |
| bool gattProfileInit(void); |
| void gattProfileDeinit(void); |
| |
| /* replies to callbacks */ |
| void gattSrvCbkReply(att_cid_t cid, att_trans_t transId, uint16_t handle, uint8_t err, const void *data, uint16_t len); /* err is ATT_ERROR_* */ |
| |
| /* callbacks */ |
| typedef bool (*gattSrvValueReadCbk)(gatt_service_t svc, l2c_handle_t who, att_cid_t cid, att_trans_t transId, uint16_t handle, uint16_t byteOfst, uint8_t reason, uint16_t len); |
| typedef bool (*gattSrvValueWriteCbk)(gatt_service_t svc, l2c_handle_t who, att_cid_t cid, att_trans_t transId, uint16_t handle, uint16_t byteOfst, uint8_t reason, uint16_t len, const void *data); |
| typedef void (*gattSrvIndCbk)(gatt_service_t svc, l2c_handle_t who, att_cid_t cid, uint16_t handle, uint8_t evt, uint64_t ref); /* GATT_SRV_EVT_* */ |
| typedef void (*gattSrvDisconnectCbk)(gatt_service_t svc, l2c_handle_t who); |
| |
| /* service lifecycle */ |
| gatt_service_t gattServiceCreate(const struct uuid *uuid, bool primary, uint16_t numHandles, gattSrvValueReadCbk readF, gattSrvValueWriteCbk writeF, gattSrvIndCbk indF, gattSrvDisconnectCbk discF); |
| bool gattServiceDestroy(gatt_service_t svc); |
| uint16_t gattServiceGetHandleBaseByUuid(const struct uuid *uuid); /* or 0 on error */ |
| uint16_t gattServiceGetHandleBaseBySvc(gatt_service_t svc); /* or 0 on error */ |
| gatt_service_t gattServiceFindByHandle(uint16_t handle, bool firstOnly); /* 0 on error */ |
| |
| /* service control */ |
| bool gattServiceStart(gatt_service_t svc, bool supportLE, bool supportEDR); |
| bool gattServiceStop(gatt_service_t svc); |
| bool gattServiceIsRunning(gatt_service_t svc); |
| bool gattServiceGetUuid(gatt_service_t svc, struct uuid *uuid); |
| |
| /* service construction (order of calls matters and is important). All return handle value or 0 on error */ |
| uint16_t gattServiceAddIncludedService(gatt_service_t svc, const struct uuid *uuid); |
| uint16_t gattServiceAddChar(gatt_service_t svc, const struct uuid *uuid, uint8_t props, uint32_t perms); |
| uint16_t gattServiceAddCharDescr(gatt_service_t svc, const struct uuid *uuid, uint32_t perms); |
| |
| /* TX path */ |
| bool gattServiceSendInd(gatt_service_t svc, att_cid_t cid, uint16_t handle, const void *data, uint16_t len, bool withConfirm, uint64_t ref); |
| |
| |
| |
| /* ==== GATT CLIENT CODE (AKA CENTRAL MODE) ==== */ |
| |
| #define GATT_CLI_STATUS_OK 0 |
| #define GATT_CLI_STATUS_OTHER_SIDE_DISC 1 /* the peer told us to go away */ |
| #define GATT_CLI_STATUS_ERR 2 /* an unknown error type in the local stack */ |
| |
| #define GATT_CLI_WRITE_TYPE_SIGNED 0 /* bluedroid has no support of this so we can assign this value to whatever we want. we pick zero for better switch() compilation */ |
| #define GATT_CLI_WRITE_TYPE_WRITE_NO_RSP 1 /* these next values must match undocumented in the *android* includes values that bluedroid uses */ |
| #define GATT_CLI_WRITE_TYPE_WRITE 2 |
| #define GATT_CLI_WRITE_TYPE_PREPARE 3 |
| |
| #define GATT_CLI_AUTH_REQ_NONE 0 /* these next values must match undocumented in the *android* includes values that bluedroid uses */ |
| #define GATT_CLI_AUTH_REQ_NO_MITM 1 /* the following 4 options are all meant to be encrypted */ |
| #define GATT_CLI_AUTH_REQ_MITM 2 |
| #define GATT_CLI_AUTH_REQ_SIGNED_NO_MITM 3 |
| #define GATT_CLI_AUTH_REQ_SIGNED_MITM 4 |
| |
| /* various callbacks */ |
| typedef void (*gattCliConnectResultCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct bt_addr *to, uint8_t status); |
| typedef void (*gattCliSvcEnumCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *uuid, bool primary, uint16_t firstHandle, uint16_t numHandles, uint8_t status); /* uuid passed as set to null after final result */ |
| typedef void (*gattCliEnumIncludedSvcsCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *uuid, uint16_t firstHandle, uint16_t numHandles, uint8_t status); |
| typedef void (*gattCliEnumCharacteristicsCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *uuid, uint16_t firstHandle, uint16_t numHandles, uint8_t status); |
| typedef void (*gattCliEnumCharDescrsCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *inThisChar, const struct uuid *uuid, uint16_t firstHandle, uint16_t numHandles, uint8_t status); |
| typedef void (*gattCliCharReadCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, uint8_t status, sg data); |
| typedef void (*gattCliCharWriteCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, uint8_t status); |
| typedef void (*gattCliCharDescrReadCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *inThisChar, const struct uuid *thisDescr, uint8_t status, sg data); |
| typedef void (*gattCliCharDescrWriteCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *inThisChar, const struct uuid *thisDescr, uint8_t status); |
| typedef void (*gattCliStagedWriteExecuteCb)(gatt_client_t cli, gatt_client_conn_t conn, bool success); |
| typedef void (*gattCliNotifSubscribeStateCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, bool forSubscribe, uint8_t status); |
| typedef void (*gattCliNotifArrivedCbk)(gatt_client_t cli, gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, bool reliable, sg data); |
| |
| |
| /* client lifecycle */ |
| gatt_client_t gattClientCreate(const struct uuid *uuid); |
| void gattClientDestroy(gatt_client_t cli); |
| |
| /* connection lifecycle */ |
| gatt_client_conn_t gattClientConnect(gatt_client_t cli, const struct bt_addr *to, gattCliConnectResultCbk resultCbk); |
| uint8_t gattClientDisconnect(gatt_client_conn_t conn); /* -> GATT_CLI_*, calls the gattCliConnectResultCbk passed to gattClientConnect() with GATT_CLI_OTHER_SIDE_DISC */ |
| |
| /* cache maintenance */ |
| bool gattClientInvalidateCache(const struct bt_addr *whomTo); //true if process started |
| |
| /* all of the following return GATT_CLI_* */ |
| |
| /* service search */ |
| uint8_t gattClientEnumServices(gatt_client_conn_t conn, const struct uuid *searchForThis, gattCliSvcEnumCbk cbk); /* searchForThis can be null to enumerate all services without filtering for that uuid. if another enumeration is ongoing, yours will wait till that one is done */ |
| |
| /* various enumerations. Each returns "next" item given "current" item. "current" is passed as NULL to get first */ |
| uint8_t gattClientEnumIncludedServices(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *prev, gattCliEnumIncludedSvcsCbk cbk); |
| uint8_t gattClientEnumCharacteristics(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *prev, gattCliEnumCharacteristicsCbk cbk); |
| uint8_t gattClientEnumCharDescriptors(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *inThisChar, const struct uuid *prev, gattCliEnumCharDescrsCbk cbk); |
| |
| /* reads/writes (writes MUST fit into MTU minus whatever, or they will be truncated) */ |
| uint8_t gattClientCharRead(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, uint8_t authReq, gattCliCharReadCbk cbk); |
| uint8_t gattClientCharWrite(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, uint8_t authReq, uint8_t writeType, uint16_t ofst, sg data, gattCliCharWriteCbk cbk); |
| uint8_t gattClientCharDescrRead(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *inThisChar, const struct uuid *thisDescr, uint8_t authReq, gattCliCharDescrReadCbk cbk); |
| uint8_t gattClientCharDescrWrite(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *inThisChar, const struct uuid *thisDescr, uint8_t authReq, uint8_t writeType, uint16_t ofst, sg data, gattCliCharDescrWriteCbk cbk); |
| uint8_t gattClientStagedWritesExecute(gatt_client_conn_t conn, bool execute, gattCliStagedWriteExecuteCb cbk); //if not execute then drop them all |
| |
| /* notification subscription/unsubscription */ |
| uint8_t gattClientNotifsSubscribe(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar, bool reliable, gattCliNotifSubscribeStateCbk stateCbk, gattCliNotifArrivedCbk arrivedCbk); |
| uint8_t gattClientNotifsUnsubscribe(gatt_client_conn_t conn, const struct uuid *inThisService, const struct uuid *thisChar); |
| |
| |
| |
| |
| |
| #endif |
| |
| |
