SPI Flash Circular Buffer

Tampon circulaire SPI Flash

C Library pour transformer un flash SPI physique en un nombre arbitraire de tampons circulaires logiques. L'interface entre SFCB et SPI Core est réalisée en tant que mémoire partagée.

Caractéristiques

• Prise en charge arbitraire SPI Flash, sélectionnable via -D à l'heure de la compilation
• Nombre arbitraire de files d'attente de tampons circulaires ( cbid ) dans un seul flash SPI
• L'interaction entre le tampon circulaire et l'interface SPI est réalisée en tant que mémoire partagée
• Système de fichiers ( Littlefs , Spiffs ) GRATUIT

Sorties

Version	Date	Source	Modifier le journal
dernier		dernier.zip

Comment

Cloner

git clone --recursive https://github.com/andkae/SPI-Flash-Circular-Buffer.git

Construire

Le makefile construit le référentiel avec un test unitaire:

$ make
gcc -c -O -Wall -Wextra -Wconversion -I . -I ../ -DW25Q16JV ./test/sfcb_test.c -o ./test/sfcb_test.o
gcc -c -O -Wall -Wextra -Wconversion -I . -I ../ -DW25Q16JV -DSFCB_PRINTF_EN ./spi_flash_cb.c -o ./test/sfcb.o
gcc -c -O -Wall -Wextra -Wconversion -I . -I ../ -DW25Q16JV  ./test/spi_flash_model/spi_flash_model.c -o ./test/spi_flash_model.o
gcc ./test/sfcb_test.o ./test/sfcb.o ./test/spi_flash_model.o -Wall -Wextra -I. -lm -o ./test/sfcb_test

La partie de la bibliothèque elle-même peut être construite avec:

gcc -c -O -Wall -Wextra -Wconversion -I . -DW25Q16JV -Werror ./spi_flash_cb.c -o ./test/sfcb.o

La mémoire flash W25Q16JV a été sélectionnée via Compile Switch -D .

Exemple

Test

Pour exécuter l'appel de test unitaire:

$ ./test/sfcb_test

API

Init

Initialise la poignée commune SFCB et affecte la mémoire.

 int sfcb_init ( t_sfcb * self , void * cb , uint8_t cbLen , void * spi , uint16_t spiLen );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
cb	Mémoire de file d'attente de tampon circulaire
CBLEN	Max. Nombre de files d'attente CB
spice	Tampon d'échange de noyau SFCB / SPI
mélanger	Taille du tampon SPI en octets

Retour:

Codes de sortie

Nouvelle file d'attente

Crée une nouvelle file d'attente de tampon circulaire indépendante logique dans le flash SPI.

 int sfcb_new_cb ( t_sfcb * self , uint32_t magicNum , uint16_t elemSizeByte , uint16_t numElems , uint8_t * cbID );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
magie	Numéro magique, doit être unique pour chaque file d'attente sur le même flash SPI
elemsizebyte	Taille de la charge utile en octet, en tête / pied de page
numelems	Nombre minimal d'éléments requis dans la file d'attente, arrondi au prochain secteur complet
cbid	ID assigné à cette file d'attente, nécessaire pour toutes les autres demandes

Retour:

Codes de sortie

Occupé

Vérifie si SFCB traite une autre demande.

 int sfcb_busy ( t_sfcb * self );

Arguments:

Arg	Description
soi	Élément de stockage SFCB

Retour:

Codes de sortie

Erreur

Dans la dernière demande, s'est terminée par une erreur.

 int sfcb_isero ( t_sfcb * self );

Arguments:

Arg	Description
soi	Élément de stockage SFCB

Retour:

Codes de sortie

Construire

Acquiert toutes les informations de file d'attente de SPI Flash. Nécessaire après avoir appelé SFCB_ADD pour mettre à jour toutes les informations de gestion.

 int sfcb_mkcb ( t_sfcb * self );

Arguments:

Arg	Description
soi	Élément de stockage SFCB

Retour:

Codes de sortie

Ajouter (ajouter)

Ajoutez les octets à l'élément de file d'attente de tampon circulaire sélectionné actuel.

 int sfcb_add ( t_sfcb * self , uint8_t cbID , void * data , uint16_t len );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
cbid	file d'attente de tampon circulaire pour interagir
*données	pointeur pour écrire des données
Len	Nombre d'octets dans * Données

Retour:

Codes de sortie

Ajouter

La force d'écriture du pied de page sinon tous les octets disponibles dans l'élément de file d'attente de tampon circulaire est occupé par ADD. Le pied de page est utilisé pour détecter une écriture complète d'un élément. La recommandation générale est d'appeler sfcb_add_done à chaque fois que vous avez terminé la rédaction de l'élément de file d'attente.

 int sfcb_add_done ( t_sfcb * self , uint8_t cbID );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
cbid	file d'attente de tampon circulaire pour interagir

Retour:

Codes de sortie

Obtenez le décalage de la charge utile

Acquérir le nombre actuel d'octets écrits dans les files d'attente. Permet l'écriture d'objets de données à plusieurs étapes à l'élément de tampon circulaire.

 uint16_t sfcb_get_pl_wrcnt ( t_sfcb * self , uint8_t cbID );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
cbid	file d'attente de tampon circulaire pour interagir

Retour:

Écrivez le nombre d'octets de l'élément de file d'attente.

Se mettre en dernier

Lisez le dernier élément de file d'attente écrit.

 int sfcb_get_last ( t_sfcb * self , uint8_t cbID , void * data , uint16_t len , uint32_t * elemID );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
cbid	file d'attente de tampon circulaire pour interagir
*données	pointeur pour lire les données
Len	Nombre d'octets dans * Données
* Elemid	numéro d'élément de file d'attente

Retour:

Codes de sortie

Flash Raw Read

Données brutes lues à partir de Flash.

 int sfcb_flash_read ( t_sfcb * self , uint32_t adr , void * data , uint16_t len );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
ADR	Adresse de mémoire SPI Flash
*données	pointeur pour lire les données
Len	Nombre d'octets dans * Données

Retour:

Codes de sortie

Travailleur

Services Demande de couche de tampon circulaire ainsi que le traitement des paquets SPI. Cette fonction doit être appelée dans une matière temporelle. Le transfert de paquets de données SPI doit utiliser un flux de données basé sur ISR.

 void sfcb_worker ( t_sfcb * self );

Arguments:

Arg	Description
soi	Élément de stockage SFCB

Retour:

Aucun.

Taille de paquet SPI

Par SFCB_Worker a créé la taille des paquets SPI en octets.

 uint16_t sfcb_spi_len ( t_sfcb * self );

Arguments:

Arg	Description
soi	Élément de stockage SFCB

Retour:

Nombre d'octets de paquet SPI.

Taille du flash

Obtenez la taille totale du type de flash compilé SFCB .

 uint32_t sfcb_flash_size ( void );

Retour:

Taille en octets.

Numéro d'élément de file d'attente le plus élevé

Obtenez le nombre d'éléments le plus élevé de file d'attente de tampon circulaire Cbid .

 uint32_t sfcb_idmax ( t_sfcb * self , uint8_t cbID );

Arguments:

Arg	Description
soi	Élément de stockage SFCB
cbid	file d'attente de tampon circulaire pour interagir

Retour:

Numéro d'élément le plus élevé.

Retour: codes de sortie

Valeur	Description
SFCB_OK	Accepté
Sfcb_e_no_flash	Aucun type de flash sélectionné, utilisez -D
Sfcb_e_mem	pas assez de mémoire attribuée dans sfcb_init
Sfcb_e_flash_full	La capacité de flash dépassait
Sfcb_e_wkr_bsy	sfcb_worker est occupé, attendez
Sfcb_e_no_cb_q	cbID d'attente de tampon circulaire n'existe pas
Sfcb_e_wkr_req	Données de gestion des tampons circulaires non préparés pour la demande, exécutez sfcb_mkcb
Sfcb_e_cb_q_mty	Aucune entrée valide dans la file d'attente

Organisation de mémoire

Le SFCB prend en charge un nombre arbitraire de files d'attente de tampons circulaires. Chaque tampon circulaire commence à l'adresse flash SPI libre la plus basse. L'architecture flash nécessite une données dédiée claire - ce que l'on appelle le secteur effacer . Grâce à cette limitation, il faut être attribué au moins deux secteurs. Sinon, l'écrasement du premier élément écrit entraînerait-il une file d'attente de tampon circulaire complète sans garder les entrées précédentes. Chaque nouvelle entrée est marquée par le plus haut 32 bits IDNUM et MagicNum . Le Magicnum assure la détection d'un élément de file d'attente de tampon circulaire occupé.

Une organisation de mémoire exemplaire pour la charge utile de 240 octets et 32 ​​éléments (= deux secteurs) montre la figure ci-dessous:

Références

• W25Q16JV
• Manifeste open source de Siemens