Skip to content

Commit

Permalink
Revise Notification/Indicatoin Implementation (#76)
Browse files Browse the repository at this point in the history 
* Add API `updateText` to `LRemoteLabel`

* Increase protocol version number and add documentation

* Use syslog instead of printf for Arduino debug messages

* Use statically allocated memory for notify/indicate requests
  • Loading branch information
@pablosun
pablosun authored Dec 18, 2017
1 parent 2cd95b6 commit 9f190fc
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 63 deletions.
4 changes: 2 additions & 2 deletions middleware/third_party/arduino/hardware/arduino/mt7697/libraries/LBLE/src/LBLE.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ void LBLEEventDispatcher::removeObserver(bt_msg_type_t msg, LBLEEventObserver* p

void LBLEEventDispatcher::dispatch(bt_msg_type_t msg, bt_status_t status, void *buff)
{
pr_debug("dispatch: msg:0x%x", msg);
// pr_debug("dispatch: msg:0x%x", msg);
auto i = m_table.find(msg);

std::vector<EventTable::iterator> removeList;
Expand All @@ -481,7 +481,7 @@ void LBLEEventDispatcher::dispatch(bt_msg_type_t msg, bt_status_t status, void *

if(i->second)
{
#if 1
#if 0
{
pr_debug("dispatch found: msg:0x%x, i->second:%p", (int)msg, i->second);
}
Expand Down
115 changes: 57 additions & 58 deletions middleware/third_party/arduino/hardware/arduino/mt7697/libraries/LBLE/src/LBLEPeriphral.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -477,80 +477,79 @@ bt_gatts_service_rec_t* LBLECharacteristicBase::allocRecord(uint32_t recordIndex
}
}

// send notification to the given connection
int LBLECharacteristicBase::_notify(bt_handle_t connection, const LBLEValueBuffer& data)

int LBLECharacteristicBase::_notifyIndicate(uint8_t opcode, bt_handle_t connection, const LBLEValueBuffer& data)
{
pr_debug("attr data size = %d", data.size());
// allocating request buffer, header + data
std::vector<uint8_t> reqBuf;
const size_t requestHeaderSize = 3;
reqBuf.resize(requestHeaderSize + data.size(), 0);
pr_debug("attr reqBuf size = %d", reqBuf.size());
// non-thread safe small buffer for typical requests
// TODO: we may want a mutex here in the future, when LBLE can be called in multiple tasks/threads.
// For now, we assume it is only possible to call LBLE within the Arduino thread.
const size_t COMMON_BUFFER_SIZE = 32; // most requrest should be smaller than 30 bytes.
static uint8_t requestBufStatic[COMMON_BUFFER_SIZE] = {0};

// calculate required buffer size
const size_t requestHeaderSize = 3; // we can't use sizeof(bt_gattc_charc_value_notification_indication_t); because it contains the "attribute_value" field
const size_t requestBufferSize = requestHeaderSize + data.size();
void *reqBuf = NULL;

// if dynamically allocated, we assume that it grows monotonically,
// hence using a static object to keep the buffer allocated.
static std::vector<uint8_t> reqBufVector;

// allocating request buffer, header + data
if(requestBufferSize <= COMMON_BUFFER_SIZE) {
// use static allocated buffer
reqBuf = requestBufStatic;
} else {
// expand - but not shrinking - the request buffer size.
if(requestBufferSize > reqBufVector.size()) {
reqBufVector.resize(requestBufferSize, 0);
}
reqBuf = &reqBufVector[0];
pr_debug("_notify reqBuf size = %d required dynamic allocation", requestBufferSize);
}
assert(reqBuf != NULL);

// alias pointer to the request buffer
bt_gattc_charc_value_notification_indication_t* pReq = (bt_gattc_charc_value_notification_indication_t*)&reqBuf[0];
pReq->attribute_value_length = requestHeaderSize + data.size();
pReq->att_req.opcode = BT_ATT_OPCODE_HANDLE_VALUE_NOTIFICATION;
bt_gattc_charc_value_notification_indication_t* pReq = (bt_gattc_charc_value_notification_indication_t*)reqBuf;
pReq->attribute_value_length = requestBufferSize;
pReq->att_req.opcode = opcode;
pReq->att_req.handle = m_attrHandle;
memcpy(pReq->att_req.attribute_value, &data[0], data.size());

// send notification - we don't expect peer to send ACK.
// send notifiction - we don't expect peer to send ACK.
const bt_status_t status = bt_gatts_send_charc_value_notification_indication(connection, pReq);

if(BT_STATUS_SUCCESS != status)
{
pr_debug("bt_gatts_send_charc_value_notification_indication fails with 0x%x", status);
{
switch(status){
case BT_STATUS_FAIL:
pr_debug("bt_gatts_send_charc_value_notification_indication fails STATUS_FAIL");
break;
case BT_STATUS_OUT_OF_MEMORY:
pr_debug("bt_gatts_send_charc_value_notification_indication fails OUT_OF_MEMORY");
break;
case BT_STATUS_CONNECTION_IN_USE:
pr_debug("bt_gatts_send_charc_value_notification_indication fails CONNECTION_INUSE");
break;
default:
pr_debug("bt_gatts_send_charc_value_notification_indication fails with 0x%x", status);
break;
}
return -1;
}

return 0;
}

// send notification to the given connection
int LBLECharacteristicBase::_indicate(bt_handle_t connection, const LBLEValueBuffer& data)
int LBLECharacteristicBase::_notify(bt_handle_t connection, const LBLEValueBuffer& data)
{
// allocating request buffer, header + data
std::vector<uint8_t> reqBuf;
const size_t requestHeaderSize = 3;
reqBuf.resize(requestHeaderSize + data.size(), 0);
pr_debug("attr reqBuf size = %d", reqBuf.size());

// alias pointer to the request buffer
bt_gattc_charc_value_notification_indication_t* pReq = (bt_gattc_charc_value_notification_indication_t*)&reqBuf[0];
pReq->attribute_value_length = requestHeaderSize + data.size();
pReq->att_req.opcode = BT_ATT_OPCODE_HANDLE_VALUE_INDICATION;
pReq->att_req.handle = m_attrHandle;
memcpy(pReq->att_req.attribute_value, &data[0], data.size());
return this->_notifyIndicate(BT_ATT_OPCODE_HANDLE_VALUE_NOTIFICATION, connection, data);
}

#if 1
const bt_status_t status = bt_gatts_send_charc_value_notification_indication(connection, pReq);
if(BT_STATUS_SUCCESS != status)
{
pr_debug("bt_gatts_send_charc_value_notification_indication fails with 0x%x", status);
return -1;
}
return 0;
#else
// send notification
bool done = waitAndProcessEvent(
// start read request
[&]()
{
const bt_status_t status = bt_gatts_send_charc_value_notification_indication(connection, pReq);
if(BT_STATUS_SUCCESS != status)
{
pr_debug("bt_gatts_send_charc_value_notification_indication fails with 0x%x", status);
}
},
// wait for event...
BT_GATTC_CHARC_VALUE_CONFIRMATION,
// and parse event result in bt task context
[](bt_msg_type_t msg, bt_status_t, void* buf)
{
pr_debug("BT_GATTC_CHARC_VALUE_CONFIRMATION with connection = 0x%x", *(bt_handle_t*)buf);
}
);
return (done == true) ? 0 : -1;
#endif
// send notification to the given connection
int LBLECharacteristicBase::_indicate(bt_handle_t connection, const LBLEValueBuffer& data)
{
return this->_notifyIndicate(BT_ATT_OPCODE_HANDLE_VALUE_INDICATION, connection, data);
}

/////////////////////////////////////////////////////////////////////////////////////////////
Expand Down
3 changes: 3 additions & 0 deletions middleware/third_party/arduino/hardware/arduino/mt7697/libraries/LBLE/src/LBLEPeriphral.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,9 @@ class LBLECharacteristicBase : public LBLEAttributeInterface
// send indication with `buf` as data and wait for ACK to the given connection
int _indicate(bt_handle_t connection, const LBLEValueBuffer& data);

private:
int _notifyIndicate(uint8_t opcode, bt_handle_t connection, const LBLEValueBuffer& data);

protected:
LBLEUuid m_uuid;
uint32_t m_perm;
Expand Down
4 changes: 2 additions & 2 deletions middleware/third_party/arduino/hardware/arduino/mt7697/variants/linkit_7697/adapter_layer.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ static void init_usr_led(void)
hal_gpio_set_output(HAL_GPIO_36, 0);
}

#if 0
#ifndef MTK_HAL_NO_LOG_ENABLE
LOG_CONTROL_BLOCK_DECLARE(wifi);
LOG_CONTROL_BLOCK_DECLARE(common);
LOG_CONTROL_BLOCK_DECLARE(BT);
Expand Down Expand Up @@ -163,7 +163,7 @@ void init_system(void)
// This resets pin status so we put it in init_system().
hal_pwm_init(PWM_SOURCE_CLOCK);

#if 0
#ifndef MTK_HAL_NO_LOG_ENABLE
log_uart_init(HAL_UART_0);
log_config_print_switch(BTMM, DEBUG_LOG_OFF);
log_init(NULL, NULL, syslog_control_blocks);
Expand Down
10 changes: 9 additions & 1 deletion middleware/third_party/arduino/hardware/arduino/mt7697/variants/linkit_7697/log_dump.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@

#define ENABLE_STDIO_TTY HAL_UART_0

#ifdef __cplusplus
extern "C" {
#endif
#include <syslog.h>
#ifdef __cplusplus
}
#endif

#define pr_debug(format, arg...) \
do{printf("[Arduino:%s:%d] " format, __func__, __LINE__, ##arg);}while(0);
do{LOG_I(common, "ARD:"format, ##arg);}while(0);

#else
#define pr_debug(format, arg...)
Expand Down

0 comments on commit 9f190fc

Please sign in to comment.