wsf buffer transfers owenrship to controller

paul-szczepanek-arm · 0xc0170 · commit 96040be349ed · 2019-05-27T06:16:49.000+01:00
diff --git a/features/FEATURE_BLE/targets/TARGET_CORDIO/driver/CordioHCITransportDriver.h b/features/FEATURE_BLE/targets/TARGET_CORDIO/driver/CordioHCITransportDriver.h
@@ -55,7 +55,7 @@ class CordioHCITransportDriver {
      * packet, ACL packet or EVT packet. Depending on the type of transport
      * it can prefix the packet itself.
      * @param len Number of bytes to transmit.
-     * @param pData pointer to the data to transmit.
+     * @param pData Pointer to the data to transmit. This is an WSF buffer and we receive ownership.
      *
      * @return The number of bytes which have been transmited.
      */
diff --git a/features/FEATURE_BLE/targets/TARGET_CORDIO/stack_adaptation/hci_tr.c b/features/FEATURE_BLE/targets/TARGET_CORDIO/stack_adaptation/hci_tr.c
@@ -80,7 +80,7 @@ void hciTrSendAclData(void *pContext, uint8_t *pData)
  *
  *  \brief  Send a complete HCI command to the transport.
  *
- *  \param  pData    WSF msg buffer containing an HCI command.
+ *  \param  pData WSF msg buffer containing an HCI command. WSF buffer ownership is released by this function.
  *
  *  \return None.
  */
@@ -95,12 +95,13 @@ void hciTrSendCmd(uint8_t *pData)
   /* dump event for protocol analysis */
   HCI_PDUMP_CMD(len, pData);
 
-  /* transmit ACL header and data */
-  if (hciDrvWrite(HCI_CMD_TYPE, len, pData) == len)
+  /* transmit ACL header and data (releases the ownership of the WSF buffer containing pData) */
+  if (hciDrvWrite(HCI_CMD_TYPE, len, pData) != len)
   {
-    /* free buffer */
-    WsfMsgFree(pData);
+    /* transport failure */
+    WSF_ASSERT(0);
   }
+  /* pData is not freed as the hciDrvWrite took ownership of the WSF buffer */
 }
 
 
diff --git a/features/FEATURE_BLE/targets/TARGET_NORDIC/TARGET_NORDIC_CORDIO/TARGET_NRF5x/NRFCordioHCITransportDriver.cpp b/features/FEATURE_BLE/targets/TARGET_NORDIC/TARGET_NORDIC_CORDIO/TARGET_NRF5x/NRFCordioHCITransportDriver.cpp
@@ -46,6 +46,7 @@ void NRFCordioHCITransportDriver::terminate()
 
 uint16_t NRFCordioHCITransportDriver::write(uint8_t hci_type, uint16_t len, uint8_t *pData)
 {
+    /* ownership of the WSF buffer is transferred to the controller (zero copy HCI) */
     return FakeChciTrRead(CHCI_TR_PROT_BLE, hci_type, len, pData);
 }
 
diff --git a/features/FEATURE_BLE/targets/TARGET_NORDIC/TARGET_NORDIC_CORDIO/TARGET_NRF5x/NRFCordioHCITransportDriver.h b/features/FEATURE_BLE/targets/TARGET_NORDIC/TARGET_NORDIC_CORDIO/TARGET_NRF5x/NRFCordioHCITransportDriver.h
@@ -51,7 +51,7 @@ class NRFCordioHCITransportDriver : public cordio::CordioHCITransportDriver {
      * packet, ACL packet or EVT packet. Depending on the type of transport
      * it can prefix the packet itself.
      * @param len Number of bytes to transmit.
-     * @param pData pointer to the data to transmit.
+     * @param pData Pointer to the data to transmit. This is an WSF buffer and we receive ownership.
      *
      * @return The number of bytes which have been transmited.
      */

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ class CordioHCITransportDriver {`
`55`	`55`	`* packet, ACL packet or EVT packet. Depending on the type of transport`
`56`	`56`	`* it can prefix the packet itself.`
`57`	`57`	`* @param len Number of bytes to transmit.`
`58`		`- * @param pData pointer to the data to transmit.`
	`58`	`+ * @param pData Pointer to the data to transmit. This is an WSF buffer and we receive ownership.`
`59`	`59`	`*`
`60`	`60`	`* @return The number of bytes which have been transmited.`
`61`	`61`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ void hciTrSendAclData(void pContext, uint8_t pData)`
`80`	`80`	`*`
`81`	`81`	`* \brief Send a complete HCI command to the transport.`
`82`	`82`	`*`
`83`		`- * \param pData WSF msg buffer containing an HCI command.`
	`83`	`+ * \param pData WSF msg buffer containing an HCI command. WSF buffer ownership is released by this function.`
`84`	`84`	`*`
`85`	`85`	`* \return None.`
`86`	`86`	`*/`
`@@ -95,12 +95,13 @@ void hciTrSendCmd(uint8_t *pData)`
`95`	`95`	`/* dump event for protocol analysis */`
`96`	`96`	`HCI_PDUMP_CMD(len, pData);`
`97`	`97`
`98`		`- /* transmit ACL header and data */`
`99`		`- if (hciDrvWrite(HCI_CMD_TYPE, len, pData) == len)`
	`98`	`+ /* transmit ACL header and data (releases the ownership of the WSF buffer containing pData) */`
	`99`	`+ if (hciDrvWrite(HCI_CMD_TYPE, len, pData) != len)`
`100`	`100`	`{`
`101`		`- /* free buffer */`
`102`		`- WsfMsgFree(pData);`
	`101`	`+ /* transport failure */`
	`102`	`+ WSF_ASSERT(0);`
`103`	`103`	`}`
	`104`	`+ /* pData is not freed as the hciDrvWrite took ownership of the WSF buffer */`
`104`	`105`	`}`
`105`	`106`
`106`	`107`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ void NRFCordioHCITransportDriver::terminate()`
`46`	`46`
`47`	`47`	`uint16_t NRFCordioHCITransportDriver::write(uint8_t hci_type, uint16_t len, uint8_t *pData)`
`48`	`48`	`{`
	`49`	`+ /* ownership of the WSF buffer is transferred to the controller (zero copy HCI) */`
`49`	`50`	`return FakeChciTrRead(CHCI_TR_PROT_BLE, hci_type, len, pData);`
`50`	`51`	`}`
`51`	`52`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ class NRFCordioHCITransportDriver : public cordio::CordioHCITransportDriver {`
`51`	`51`	`* packet, ACL packet or EVT packet. Depending on the type of transport`
`52`	`52`	`* it can prefix the packet itself.`
`53`	`53`	`* @param len Number of bytes to transmit.`
`54`		`- * @param pData pointer to the data to transmit.`
	`54`	`+ * @param pData Pointer to the data to transmit. This is an WSF buffer and we receive ownership.`
`55`	`55`	`*`
`56`	`56`	`* @return The number of bytes which have been transmited.`
`57`	`57`	`*/`