Обновить README.md
This commit is contained in:
20
README.md
20
README.md
@@ -2,15 +2,29 @@
|
||||
|
||||
Папка _CubeKeil Example_ содержит проект, который демонстрирует работу с библиотеками.
|
||||
|
||||
Папка _GENERAL_ содержит кастомные библиотеки для периферии. В данном проекте используется только "_gpio_general.c/.h_" и общий файл "_peripheral_general.h_" для настройки GPIO для SPI.
|
||||
|
||||
Папка _memory_spi_ содержит библиотеку для SPI памяти (FLASH/EEPROM): два файла "_spi_flash.c/.h_".
|
||||
Папка _memory_spi_ содержит библиотеку для SPI памяти (FLASH/EEPROM): два файла "_memory_spi.c/.h_".
|
||||
|
||||
## Функции SPI MEMORY
|
||||
Общение с памятью на уровне железа выполняют [функции для команд](#функции-для-команд).
|
||||
Координацию команд выполняют [функции для внутреннего использования](#функции-для-внутреннего-использования).
|
||||
А запросы на запись/чтение/очистку произвольного кол-ва байт выполняют [функции для пользователя](#функции-для-пользователя).
|
||||
|
||||
|
||||
## Пример
|
||||
|
||||
```c
|
||||
MEMSPI_HandleTypeDef hmemspi;
|
||||
HAL_StatusTypeDef MEMSPI_RES;
|
||||
|
||||
hmemspi.CS_GPIOx = GPIOC;
|
||||
hmemspi.CS_PIN = GPIO_PIN_4;
|
||||
MEMSPI_Base_Init(&hmemspi, &hspi3);
|
||||
|
||||
MEMSPI_RES = MEMSPI_EEPROM_Write(&hmemspi, mem_adr, write_buff, buff_size, Timeout, 1);
|
||||
MEMSPI_RES = MEMSPI_Read_Memory(&hmemspi, mem_adr, read_buff, buff_size, Timeout);
|
||||
```
|
||||
|
||||
|
||||
### Функции для пользователя
|
||||
- MEMSPI_Base_Init() Инициализация переферии SPI и GPIO для внешней памяти
|
||||
- MEMSPI_Read_Memory() Считывание внешней FLASH/EEPROM
|
||||
|
||||
Reference in New Issue
Block a user