Update README according to the current API
authorJean THOMAS <git0@pub.jeanthomas.me>
Tue, 9 Jun 2020 14:49:41 +0000 (16:49 +0200)
committerJean THOMAS <git0@pub.jeanthomas.me>
Tue, 9 Jun 2020 14:49:41 +0000 (16:49 +0200)
libgram/README.md

index f7db922d380375a8dab74b4eb467d3bf4a8fe9c2..965c663e78a87933c1b7bdad2697402bfbbc2466 100644 (file)
@@ -4,21 +4,14 @@ libgram is the C library for gram core initialization.
 
 ## HowTo
 
-Provide the CSV file from your LambdaSoC build to the Makefile:
-
-```bash
-make CSR_CSV_FILE=$SOC_BUILD/soc/soc_resources.csv
-```
-
-In your firmware:
+Build libgram with make. In your firmware:
 
 ```C
 #include <gram.h>
 
 int main(void) {
-       int err = gram_init();
-
-       /* insert something meaningful here */
+       struct gramCtx ctx;
+       int err = gram_init(&ctx, 0x10000000, 0x00006000, 0x00005000);
 
        return 0;
 }
@@ -31,5 +24,4 @@ Link it to this library and you should be good to go!
 ```
 GRAM_ERR_NONE: No error happened (hardcoded to zero)
 GRAM_ERR_UNDOCUMENTED: Undocumented error, shame on us lazy coders (take a look at the code)
-GRAM_ERR_MEMTEST: Memtest failed
 ```