Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
S
SDB - Self-describing Bus
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
SDB - Self-describing Bus
Commits
95bef107
Commit
95bef107
authored
Oct 08, 2014
by
Alessandro Rubini
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
sdbfs/doc: document new functions
Signed-off-by:
Alessandro Rubini
<
rubini@gnudd.com
>
parent
c4933f3b
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
3 deletions
+16
-3
sdbfs.in
sdbfs/doc/sdbfs.in
+16
-3
No files found.
sdbfs/doc/sdbfs.in
View file @
95bef107
...
...
@@ -161,10 +161,15 @@ the public fields:
If the filesystem is directly mapped, the user may fill this
pointer and avoid declaring the @i
{
read
}
method described next.
We removed ``datalen'' as not really needed or used so far.
@item unsigned long
datalen
;
@item unsigned long
flags
;
The length of the mapped area.
Flags: @t
{
SDBFS
_
F
_
VERBOSE
}
and @t
{
SDBFS
_
F
_
ZEROBASED
}
. The former
is not currently used, but is provided for forward compatibility
and easing library debugging. The latter means that the @t
{
data
}
pointer is valid even if 0. This is useful in microcontroller
systems where the @sc
{
sdb
}
addresses refer to zero-based areas.
@item int (*read)(struct sdbfs *fs, int offset, void *buf, int count);
...
...
@@ -201,7 +206,8 @@ number in case of error, within the @i{errno} range (e.g. @code{-ENOENT}).
@item struct sdbfs *sdbfs
_
dev
_
find(const char *name);
If the user registered more than one device, this function
If the user registered more than one device (i.e. @sc
{
sdb
}
tree),
this function
can be used to scan the list of devices and return one according
to its own @code
{
name
}
field.
...
...
@@ -218,6 +224,13 @@ number in case of error, within the @i{errno} range (e.g. @code{-ENOENT}).
approaches, but it allows keeping down the footprint of both the
library and user code.
@item unsigned long sdbfs
_
find
_
name(struct sdbfs *fs, const char *name);
@itemx unsigned long sdbfs
_
find
_
id(struct sdbfs *fs, uint64
_
t vid, uint32
_
t did);
The functions are the counterpart of the @i
{
open
}
above for
@sc
{
fpga
}
cores. They return the base address of the core with
a specific name or id-pair.
@item struct sdb
_
device *sdbfs
_
scan(struct sdbfs *fs, int newscan);
The function can be used to get a listing of the @i
{
sdb
}
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment