aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSuman Anna2020-10-12 20:57:03 -0500
committerSuman Anna2020-10-16 18:26:02 -0500
commitd3641051f457af209a40c5df6478b733e1f60219 (patch)
tree9ad5f7e9b7b9f4657cb0f58af2be5b268eb09bbc
parenta914709fe79d48571799d172c020409da6bac2ad (diff)
downloadti-rpmsg-char-d3641051f457af209a40c5df6478b733e1f60219.tar.gz
ti-rpmsg-char-d3641051f457af209a40c5df6478b733e1f60219.tar.xz
ti-rpmsg-char-d3641051f457af209a40c5df6478b733e1f60219.zip
docs: Add a top-level README file
Add a README file at the top-level that provides some basic introduction and build steps. Signed-off-by: Suman Anna <s-anna@ti.com>
-rw-r--r--README79
1 files changed, 79 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..d42989b
--- /dev/null
+++ b/README
@@ -0,0 +1,79 @@
1TI RPMsg Char Package
2======================
3
41. Introduction
5----------------
6This repo contains the source code for a small rpmsg-char utility library
7and some basic examples and/or tests exercising the API provided by the
8ti_rpmsg_char library. The library is primarily designed to provide Linux
9applications an easy means to open and identify rpmsg character devices
10created by the Linux kernel rpmsg-char driver using the virtio-rpmsg-bus
11transport back-end.
12
13The library currently supports the TI K3 AM65x, J721E and J7200 SoCs, but
14can be easily scaled to support other SoCs.
15
16
172. Sources
18-----------
19The repo is maintained as a git tree, and so the sources can simply be
20downloaded using git.
21
22 git clone git://git.ti.com/rpmsg/ti-rpmsg-char.git
23
24The following is the directory structure for this package:
25 - src : Library source code and internal header files
26 - include : Public exported headers for applications usage
27 - examples : Example source code
28
29
303. API
31-------
32The library provides only 4 basic API. Please see the documentation in
33include/ti_rpmsg_char.h for each of the API and function arguments.
34
35 - rpmsg_char_init()
36 - rpmsg_char_exit()
37 - rpmsg_char_open()
38 - rpmsg_char_close()
39
40Applications need only include the ti_rpmsg_char.h. All the remoteproc
41ids to be used are defined in rproc_id.h, which is already included in
42ti_rpmsg_char.h.
43
44
454. Build
46---------
47
484.1 Infrastructure Tools
49The package uses the autotools infrastructure for build. The following
50versions are used:
51 GNU autoconf : 2.69
52 GNU automake : 1.15.1
53 GNU libtool : 2.4.6
54
55The following Arm cross-compilers are used to build the library and
56examples:
57 v8 Compiler : gcc-arm-9.2-2019.12-x86_64-aarch64-none-linux-gnu
58 v7 Compiler : gcc-arm-9.2-2019.12-x86_64-arm-none-linux-gnueabihf
59
604.2 Build Steps
61 1. Install the necessary autotools and compilers
62 2. Add the installed compiler bin path to your PATH variable
63 eg: export PATH=<install_path>/gcc-arm-9.2-2019.12-aarch64/bin:$PATH
64 3. Configure the autotools with necessary host and optional prefix to be
65 used to install the build libraries and executables
66 cd <ti-rpmsg-char-dir>
67 autoreconf -i
68 ./configure --host=aarch64-none-linux-gnu --prefix=<target-dir>
69 4. Build and Install
70 make
71 make install
72
734.3 Clean Steps
74 1. Use the desired generic Makefile targets
75 make clean : Erase the files built by make
76 make distclean : clean + Erase the files created by the configure step
77 make uninstall : Erase the installed libraries and executables
78 2. Use git clean to get the repo back to a pristine state
79 git clean -dfx