Skip to content

Commit

Permalink
Edit README.md
Browse files Browse the repository at this point in the history
The DMA/Interrupt peripheral note update and the SPI test issue
was missing. The first one was added to README.md. The second one
was added to the CHANGELOG.md

README.md refinement for DMA Interrupt and required memory suikan4github#17
suikan4github#17
  • Loading branch information
suikan4github committed Feb 23, 2019
1 parent 7f5c1ae commit 2aec3a7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Record of the modification in project development.
- [Issue 7 : README.md doesn't have link to the "where to get" at ToC](https://github.com/suikan4github/murasaki/issues/7)
- [Issue 15 : Write a Program flow walk through](https://github.com/suikan4github/murasaki/issues/15)
### Security

### Known Issue
- The SPI slave transfer is not tested.
## [0.1.0] - 2019-02-11

### Added
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,12 @@ the program may be broken.
To prevent this problem, Murasaki guards the important portion of the control program by a critical section.
Thus, the programmer doesn't need to care the exclusive access to the peripheral.

The Murasaki peripheral classes uses DMA/Interrupt transfer.
The interrupt/DMA access is also important to utilize the CPU under an RTOS environment.
STM32Cube HAL provides a polling version of API. These API has a waiting loop inside.
As a result, such the API will occupy the CPU while it waits for an event.
The interrupt/DMA based peripheral access utilize the CPU with high efficiency under the RTOS environment.
While STM32Cube HAL provides a polling version of API, these API has a waiting loop inside.
As a result, such the polling API will occupy the CPU while it waits for an event.
The interrupt/DMA based peripheral access doesn't have such the waitingloop, thus RTOS
can utilize CPU for other tasks, while peripheral doens't need CPU's help.

The blocking IO guarantees the end of a communication when the program returns from one IO function.
Then, once returned from the function, for example, received data is ready to use in an RX buffer.
Expand Down

0 comments on commit 2aec3a7

Please sign in to comment.