aws / aws/common-io-basic

The requirement for iot_uart_ioctl() with xUartRequest = eGetTxNoOfbytes or eGetRxNoOfbytes is not reasonable

Offen
#4 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C
Sterne
16
Forks
10
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Hello,

We are thinking of developing our own device driver as compliant to common-io-basic interface.
Among all, we are facing an issue with iot_uart_ioctl() definition as below.

----

# Description

The requirement for iot_uart_ioctl() with xUartRequest = eGetTxNoOfbytes or eGetRxNoOfbytes is not reasonable.

# Test Steps

N/A.
This is an issue with API definitions.

# Target Revision

ddfb538 (or any version on and after 8151c98).

# Details

iot_uart.h says eGetTxNoOfbytes (eGetRxNoOfbytes) requires "If the last operation was read, this returns 0" (If the last operation was write, this returns 0"). See below.

 * @note eGetTxNoOfbytes returns the number of written bytes in last operation.

* This is supposed to be called in the caller task or application callback, right after last operation completes.
* This request expects 2 bytes buffer (uint16_t).
*
* - If the last operation was write, this returns the actual number of written bytes which might be smaller than the requested number (partial write).
* - If the last operation was read, this returns 0.
*
* @note eGetRxNoOfbytes returns the number of read bytes in last operation.
* This is supposed to be called in the caller task or application callback, right after last operation completes.
* This request expects 2 bytes buffer (uint16_t).
*
* - If the last operation was read, this returns the actual number of read bytes which might be smaller than the requested number (partial read).
* - If the last operation was write, this returns 0.

As test/test_iot_uart.c implies, we assume here **you can call iot_uart_read_async() and iot_uart_write_async() concurrently**.

In such concurrent call case, "the last operation" could change in an unexpected manner, and therefore the return value for eGetTxNoOfbytes/eGetRxNoOfbytes could be unreliable.

Imagine the events occur in the following order.

* (1) Call iot_uart_write_async()
* (2) Call iot_uart_read_async()
* (3) Async write operation is complete and the callback function is called with xOpStatus = eUartWriteCompleted
* (4) Call iot_uart_ioctl() with xUartRequest = eGetTxNoOfbytes

In (4), the guy who codes this does want to get the number of successfully written bytes in (1) and (3).

But according to iot_uart.h, this guy could get 0 in this case because "the last operation was(or could be) read".
Probably, this result is not what most people expect.

I suggest we remove "If the last operation was read, this returns 0" and "If the last operation was write, this returns 0" out of this definition.
What do you think of this idea ?

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit den Definitionen von eGetTxNoOfbytes und eGetRxNoOfbytes in iot_uart.h und lies anschließend test/test_iot_uart.c, um die angenommenen gleichzeitigen asynchronen Operationen zu verstehen. Ermittle das vorgesehene Verhalten, wenn Lese- und Schreibvorgänge sich überschneiden, und dokumentiere die vereinbarten API-Semantiken in iot_uart.h mit Tests, die diese Entscheidung abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
c
Bereich
api, embedded-iot
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.