[STM32/HAL] simples U(S)ART-Library

[Harry L. (mysth)]

Ich möchte hier meinen Code zur komfortablen Nutzung der STM32 U(S)ARTs 
vorstellen.
Es können theoretisch beliebig viele U(S)ARTs konfiguriert werden.

Ich hab mich bemüht, den Code soweit wie nötig zu kommentieren.

Zum Testen muß man ein neues Projekt in CubeMX generieren, und dort den 
gewünschten U(S)ART aktivieren und konfigurieren.
Bitte nicht vergessen auch den Interrupt dieses U(S)ART einzuschalten!

Die Dateien aus dem Zip kopiert man einfach in Core/SRC

Für einen ersten Test habe ich ein simples Demo angehängt. (uart_demo.c, 
und uart_demo.h)

Um das zu nutzen muß man in der generierten main.c die Datei uart_demo.h 
zu den Includes hinzufügen:

/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
#include "uart_demo.h"
/* USER CODE END Includes */

In der main-Funktion wird dann das eigentliche Demo gestartet, und als 
einziger Parameter der Handle des gewünschten U(S)ART übergeben:

  /* USER CODE BEGIN 2 */

  myUART_LineDemo(&huart2);

  /* USER CODE END 2 */

Der Rest sollte selbsterklärend sein. (In der uart_demo.c und 
uart_demo.h)

Der eigentliche Test findet dann in einem Terminalprogramm deiner Wahl 
statt.

Über Anregungen und/oder Verbesserungs-Vorschläge würde ich mich freuen.

Da das die erste Version ist, kann ich kleinere Bugs im Code derzeit 
nicht ausschließen, allerdings funktioniert das in meinem Labor in NRW 
bei ca 22° Raumtemperatur schon recht zuverlässig.

Viel Spass damit!

[Harry L. (mysth)]

Noch einen kleinen Bug gefixed und Kommentare im Source ergänzt.

[Harry L. (mysth)]

Und noch ein kleineres Update.

[Jens R. (tmaniac)]

Schöne Idee. Hast du dir mal überlegt da ein Expansion Pack draus zu 
basteln?

Ich bin (mal mehr und mal weniger) dabei so etwas für den CAN (aktuell 
Unterstützung des bxCAN) zu basteln. Und ich habe die Konfiguration in 
die Cube-Oberfläche integriert.

[Harry L. (mysth)]

Jens R. schrieb:
> Schöne Idee. Hast du dir mal überlegt da ein Expansion Pack draus zu
> basteln?
>
> Ich bin (mal mehr und mal weniger) dabei so etwas für den CAN (aktuell
> Unterstützung des bxCAN) zu basteln. Und ich habe die Konfiguration in
> die Cube-Oberfläche integriert.

Gute Idee!
Muß ich mir mal anschauen!

[Harry L. (mysth)]

Version 2.0 mit FreeRTOS-Support

[Wastl (hartundweichware)]

Harry L. schrieb:
> [STM32/HAL] simples U(S)ART-Library

Das Library?

Harry L. schrieb:
> UARTlib_v2.zip

Immer noch die Bindestrich-Krankheit? Ist anstrengend, ich weiss.

Wastl schrieb:
> Du hast die Bindestrich-Krankheit. In der englischen Sprache wird
> der Bindestrich nur in (sehr) besonderen Fällen verwendet.
> Beispiel: state-of-the-art programming
> Da du englischsprachige Texte schreibst nehme ich an dass du dich
> an englischsprachiche User wenden möchtest. Dann bitte keine
> Deppen-Bindestriche.

[Harry L. (mysth)]

Version 2.01
Bugfix und Demo erweitert.

[Harry L. (mysth)]

Und noch ein letztes Update für heute.

Das API sieht nun folgendermaßen aus (aus uartlib_api.h):

/*****************************************************************************
 *
 * initialize uart-system
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * UART_HandleTypeDef *huart : HAL-handle to the used UART
 *
 * const char uart_name[] : pointer to a human readable name of this uart
 *
 *****************************************************************************/

void uart_init(UART_com_t *UART_com, UART_HandleTypeDef *huart, const char uart_name[]);

/*****************************************************************************
 *
 * switch to raw-mode
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * every single received byte is returned by uart_receive()
 *
 * this mode is the default after initialisation
 *
 *****************************************************************************/

void uart_set_rawmode(UART_com_t *UART_com);

/*****************************************************************************
 *
 * switch to string-mode
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * char *stringbuf : a pointer to an buffer used for internaly construct the received string
 * size_t bufsize : size of this buffer which is also the max. string-length
 *
 * char termchar : a character (usualy <CR>) that is interpreted as an end of line
 *
 * bool echo : when true, every char is echoed on output. usable for manual input.
 * in case of echo = true, <BS> may be used, to edit the input line
 *
 *****************************************************************************/

void uart_set_stringmode(UART_com_t *UART_com, char *stringbuf, size_t bufsize,
    char termchar, bool echo);

/*****************************************************************************
 *
 * receive data from uart
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * uint8_t *result : a pointer to a buffer where the received data is copied to
 * 
 * in rawmode this is a single byte
 *
 * in stringmode, the buffersize has to be equal or bigger than the buffer-size
 * set in uart_set_stringmode()
 *
 * return:
 * in non-rtos-mode it returns true if data has been received and copied
 * false is returned if no data is available
 *
 * in rtos-mode the control is passed to the rtos, and the function
 * returns true as soon as data is available and copied to the result-buffer
 *
 *****************************************************************************/

bool uart_receive(UART_com_t *uart, uint8_t *result);

/*****************************************************************************
 *
 * transmit single byte
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * uint8_t byte : the byte to be tranmitted
 *
 *****************************************************************************/

void uart_put_byte(UART_com_t *Serial_COM, uint8_t byte);

/*****************************************************************************
 *
 * transmit array of data
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * uint8_t *data : pointer to an array of bytes to be tranmitted
 *
 * size_t cnt : number of bytes to transmit
 *
 *****************************************************************************/

void uart_put_data(UART_com_t *Serial_COM, uint8_t *data, size_t cnt);

/*****************************************************************************
 *
 * transmit a single char
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * char c : the char to be tranmitted
 *
 *****************************************************************************/

void uart_putc(UART_com_t *Serial_COM, char c);

/*****************************************************************************
 *
 * transmit a null-terminated string
 *
 * parameter:
 * UART_com_t *UART_com : pointer to an user-created UART_com_t structure
 *
 * char *s : a pointer to the string to transmit
 *
 *****************************************************************************/

void uart_puts(UART_com_t *Serial_COM, char *s);