Skip to content

Commit c9f7df3

Browse files
committed
canio: Give implementation-specific limits for CAN.Listen
1 parent bdc1343 commit c9f7df3

File tree

1 file changed

+18
-1
lines changed
  • shared-bindings/canio

1 file changed

+18
-1
lines changed

shared-bindings/canio/CAN.c

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,24 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(canio_can_restart_obj, canio_can_restart);
214214
//|
215215
//| An empty filter list causes all messages to be accepted.
216216
//|
217-
//| Timeout dictates how long receive() and next() will block."""
217+
//| Timeout dictates how long receive() and next() will block.
218+
//|
219+
//| Platform specific notes:
220+
//|
221+
//| SAM E5x supports two Listeners. Filter blocks are shared between the two
222+
//| listeners. There are 4 standard filter blocks and 4 extended filter blocks.
223+
//| Each block can either match 2 single addresses or a mask of addresses.
224+
//| The number of filter blocks can be increased, up to a hardware maximum, by
225+
//| rebuilding CircuitPython, but this decreases the CircuitPython free
226+
//| memory even if canio is not used.
227+
//|
228+
//| STM32F405 supports two Listeners. Filter blocks are shared between the two listeners.
229+
//| There are 14 filter blocks. Each block can match 2 standard addresses with
230+
//| mask or 1 extended address with mask.
231+
//|
232+
//| ESP32S2 supports one Listener. There is a single filter block, which can either match a
233+
//| standard address with mask or an extended address with mask.
234+
//| """
218235
//| ...
219236
//|
220237
STATIC mp_obj_t canio_can_listen(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {

0 commit comments

Comments
 (0)