OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/bluetooth/controller/util/mayfly.h

32 lines
857 B
C
Raw Normal View History

Bluetooth: Controller: Add a util folder with basic primitives The util folder contains memory management, queue management and misc utilities used by the Link Layer implementation. This will be in time replaced by Zephyr's native functionality. Jira: ZEP-702 Origin: Original Change-Id: Id8602ea41ec44811801dfc582bab244c339eabe3 Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2016-08-15 18:16:30 +08:00
/*
* Copyright (c) 2016 Nordic Semiconductor ASA
* Copyright (c) 2016 Vinayak Kariappa Chettimada
*
license: Replace Apache boilerplate with SPDX tag Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-01-19 09:01:01 +08:00
* SPDX-License-Identifier: Apache-2.0
Bluetooth: Controller: Add a util folder with basic primitives The util folder contains memory management, queue management and misc utilities used by the Link Layer implementation. This will be in time replaced by Zephyr's native functionality. Jira: ZEP-702 Origin: Original Change-Id: Id8602ea41ec44811801dfc582bab244c339eabe3 Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2016-08-15 18:16:30 +08:00
*/
Bluetooth: Controller: replace work with mayfly This commit introduces a very light-weight and lock-less scheduling of the Controller's deferred function calls called the Mayfly. Earlier work implementation used in the Controller had an O(n) to schedule a function in a linked list that used IRQ lock during modification of the linked list in the Controller's ISR executions. Mayfly is a compile time configurable matrix of queues where an execution context-safe queue exists between two execution context, one being the caller and the second being the callee. Callee(s) are run in a software interrupt but can also be run in an OS thread. There are minor clean ups too in this commit related to folder structure. Change-id: I5ff44dcee6679d2f5ce9e8437d98d6c868782f3d Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2016-12-21 13:21:13 +08:00
#ifndef _MAYFLY_H_
#define _MAYFLY_H_
Bluetooth: Controller: Add a util folder with basic primitives The util folder contains memory management, queue management and misc utilities used by the Link Layer implementation. This will be in time replaced by Zephyr's native functionality. Jira: ZEP-702 Origin: Original Change-Id: Id8602ea41ec44811801dfc582bab244c339eabe3 Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2016-08-15 18:16:30 +08:00
Bluetooth: Controller: replace work with mayfly This commit introduces a very light-weight and lock-less scheduling of the Controller's deferred function calls called the Mayfly. Earlier work implementation used in the Controller had an O(n) to schedule a function in a linked list that used IRQ lock during modification of the linked list in the Controller's ISR executions. Mayfly is a compile time configurable matrix of queues where an execution context-safe queue exists between two execution context, one being the caller and the second being the callee. Callee(s) are run in a software interrupt but can also be run in an OS thread. There are minor clean ups too in this commit related to folder structure. Change-id: I5ff44dcee6679d2f5ce9e8437d98d6c868782f3d Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2016-12-21 13:21:13 +08:00
struct mayfly {
uint8_t volatile _req;
uint8_t _ack;
void *_link;
void *param;
void (*fp)(void *);
Bluetooth: Controller: Add a util folder with basic primitives The util folder contains memory management, queue management and misc utilities used by the Link Layer implementation. This will be in time replaced by Zephyr's native functionality. Jira: ZEP-702 Origin: Original Change-Id: Id8602ea41ec44811801dfc582bab244c339eabe3 Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2016-08-15 18:16:30 +08:00
};
Bluetooth: Controller: replace work with mayfly This commit introduces a very light-weight and lock-less scheduling of the Controller's deferred function calls called the Mayfly. Earlier work implementation used in the Controller had an O(n) to schedule a function in a linked list that used IRQ lock during modification of the linked list in the Controller's ISR executions. Mayfly is a compile time configurable matrix of queues where an execution context-safe queue exists between two execution context, one being the caller and the second being the callee. Callee(s) are run in a software interrupt but can also be run in an OS thread. There are minor clean ups too in this commit related to folder structure. Change-id: I5ff44dcee6679d2f5ce9e8437d98d6c868782f3d Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2016-12-21 13:21:13 +08:00
void mayfly_init(void);
Bluetooth: Controller: Run all enqueued mayfly before disable Controller asserted in preparation of a role event due to the previous (same or another) role event preparation being not complete. Mayfly callee was disabled in the previous event due to the preparation time being short and previous start running (higher natural priority) before all previous preparation mayfly completed. The previous start disabled mayfly to avoid Radio ISR latencies. The current role event that asserted, preempted the previous role (observer role with continuous scanning window) which runs until preemption to maximise the Radio h/w use (observer scanning until next interval). The previous preparation mayfly is still disabled when the current role preparation tries to use same mayfly instance which should be free for a new enqueue. This commit updates mayfly implementation so that mayfly callee is disabled only after all enqueued mayfly instances are run to completion. Jira: ZEP-1839 Change-id: I3e0d31422db8e47b819189110b11ebd07dd09a7c Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2017-03-04 11:58:22 +08:00
void mayfly_enable(uint8_t caller_id, uint8_t callee_id, uint8_t enable);
Bluetooth: Controller: replace work with mayfly This commit introduces a very light-weight and lock-less scheduling of the Controller's deferred function calls called the Mayfly. Earlier work implementation used in the Controller had an O(n) to schedule a function in a linked list that used IRQ lock during modification of the linked list in the Controller's ISR executions. Mayfly is a compile time configurable matrix of queues where an execution context-safe queue exists between two execution context, one being the caller and the second being the callee. Callee(s) are run in a software interrupt but can also be run in an OS thread. There are minor clean ups too in this commit related to folder structure. Change-id: I5ff44dcee6679d2f5ce9e8437d98d6c868782f3d Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2016-12-21 13:21:13 +08:00
uint32_t mayfly_enqueue(uint8_t caller_id, uint8_t callee_id, uint8_t chain,
struct mayfly *m);
void mayfly_run(uint8_t callee_id);
Bluetooth: Controller: Run all enqueued mayfly before disable Controller asserted in preparation of a role event due to the previous (same or another) role event preparation being not complete. Mayfly callee was disabled in the previous event due to the preparation time being short and previous start running (higher natural priority) before all previous preparation mayfly completed. The previous start disabled mayfly to avoid Radio ISR latencies. The current role event that asserted, preempted the previous role (observer role with continuous scanning window) which runs until preemption to maximise the Radio h/w use (observer scanning until next interval). The previous preparation mayfly is still disabled when the current role preparation tries to use same mayfly instance which should be free for a new enqueue. This commit updates mayfly implementation so that mayfly callee is disabled only after all enqueued mayfly instances are run to completion. Jira: ZEP-1839 Change-id: I3e0d31422db8e47b819189110b11ebd07dd09a7c Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2017-03-04 11:58:22 +08:00
extern void mayfly_enable_cb(uint8_t caller_id, uint8_t callee_id,
uint8_t enable);
Bluetooth: Controller: replace work with mayfly This commit introduces a very light-weight and lock-less scheduling of the Controller's deferred function calls called the Mayfly. Earlier work implementation used in the Controller had an O(n) to schedule a function in a linked list that used IRQ lock during modification of the linked list in the Controller's ISR executions. Mayfly is a compile time configurable matrix of queues where an execution context-safe queue exists between two execution context, one being the caller and the second being the callee. Callee(s) are run in a software interrupt but can also be run in an OS thread. There are minor clean ups too in this commit related to folder structure. Change-id: I5ff44dcee6679d2f5ce9e8437d98d6c868782f3d Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2016-12-21 13:21:13 +08:00
extern uint32_t mayfly_is_enabled(uint8_t caller_id, uint8_t callee_id);
extern uint32_t mayfly_prio_is_equal(uint8_t caller_id, uint8_t callee_id);
extern void mayfly_pend(uint8_t caller_id, uint8_t callee_id);
Bluetooth: Controller: Add a util folder with basic primitives The util folder contains memory management, queue management and misc utilities used by the Link Layer implementation. This will be in time replaced by Zephyr's native functionality. Jira: ZEP-702 Origin: Original Change-Id: Id8602ea41ec44811801dfc582bab244c339eabe3 Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2016-08-15 18:16:30 +08:00
Bluetooth: Controller: replace work with mayfly This commit introduces a very light-weight and lock-less scheduling of the Controller's deferred function calls called the Mayfly. Earlier work implementation used in the Controller had an O(n) to schedule a function in a linked list that used IRQ lock during modification of the linked list in the Controller's ISR executions. Mayfly is a compile time configurable matrix of queues where an execution context-safe queue exists between two execution context, one being the caller and the second being the callee. Callee(s) are run in a software interrupt but can also be run in an OS thread. There are minor clean ups too in this commit related to folder structure. Change-id: I5ff44dcee6679d2f5ce9e8437d98d6c868782f3d Signed-off-by: Vinayak Chettimada <vinayak.kariappa.chettimada@nordicsemi.no>
2016-12-21 13:21:13 +08:00
#endif /* _MAYFLY_H_ */