diff options
Diffstat (limited to 'documentation/README.release')
-rw-r--r-- | documentation/README.release | 260 |
1 files changed, 260 insertions, 0 deletions
diff --git a/documentation/README.release b/documentation/README.release new file mode 100644 index 0000000..ed8f2d3 --- /dev/null +++ b/documentation/README.release | |||
@@ -0,0 +1,260 @@ | |||
1 | |||
2 | Enea Linux 5 for PPC | ||
3 | ==================== | ||
4 | |||
5 | Release version: 5.0-ppc | ||
6 | |||
7 | This README provides a quick introduction on how to boot Enea Linux | ||
8 | and install packages using the smart package manager. | ||
9 | |||
10 | In this README you will find the following information: | ||
11 | * WHAT IS ENEA LINUX | ||
12 | * DOCUMENTTION | ||
13 | * QUICK GETTING STARTED | ||
14 | * DELIVERABLES IN THIS RELEASE | ||
15 | * HOW TO USE SMART PACKAGE MANAGER | ||
16 | * SUPPORT INFORMATION | ||
17 | |||
18 | |||
19 | WHAT IS ENEA LINUX | ||
20 | ================== | ||
21 | |||
22 | Enea Linux is an open source distribution providing hardened and well supported | ||
23 | Linux for customized hardware. The source code is continuously downstreamed | ||
24 | from Yocto Project (www.yoctoproject.org - Yocto Project, A Linux Foundation | ||
25 | Collaborative Project. All Rights Reserved.) and tested by Enea. | ||
26 | |||
27 | With Enea Linux you get a Yocto Project compatible development environment | ||
28 | allowing you to build embedded Linux kernels and toolchains on a Linux host, | ||
29 | to customize embedded Linux kernels for a specific hardware architecture, | ||
30 | and to build and troubleshoot embedded Linux applications on target. | ||
31 | |||
32 | Enea Linux provides you with verified and easily installed board support | ||
33 | packages (BSP) for your hardware architectures. Each BSP includes a Linux kernel | ||
34 | and a root filesystem (rootfs), plus a number of packages that can be extended | ||
35 | on request. You also get the packages required for building images on any of | ||
36 | the supported Linux distributions for your host. | ||
37 | |||
38 | This version of Enea Linux is distributed via linux.enea.com and is publicly | ||
39 | available for download. | ||
40 | |||
41 | Read more about Enea Linux on www.enea.com. | ||
42 | |||
43 | |||
44 | QUICK GETTING STARTED | ||
45 | ===================== | ||
46 | The steps below summarize how to install, build, and boot Enea Linux. | ||
47 | For B-D you find detailed instructions in Enea Linux User's Guide, | ||
48 | chapters "Getting Started" and "Target Guide". | ||
49 | |||
50 | A. Prepare the installation: | ||
51 | * Browse to https://linux.enea.com/5.0-ppc/documentation | ||
52 | * Read the Release Information | ||
53 | * Open the User's Guide | ||
54 | |||
55 | B. Install Enea Linux on host: | ||
56 | |||
57 | 1. Ensure that system requirements are met. | ||
58 | |||
59 | 2. Install the packages needed for your host's Linux distribution. | ||
60 | |||
61 | 3. Download tarballs and install them on the host. | ||
62 | The top directory of each tarball is Enea-Linux-5.0-ppc. | ||
63 | |||
64 | # Download Enea-Linux-5.0-ppc.tar.gz # precompiled images | ||
65 | $ tar xzf Enea-Linux-5.0-ppc.tar.gz | ||
66 | |||
67 | # Download Enea-Linux-doc_5.0-ppc.tar.gz # documentation | ||
68 | $ tar xzf Enea-Linux-doc_5.0-ppc.tar.gz | ||
69 | |||
70 | $ cd Enea-Linux-5.0-ppc | ||
71 | # Download Enea-Linux-Eclipse_4.0.tar.gz # Eclipse with plug-ins | ||
72 | $ tar xzf Enea-Linux-Eclipse_4.0.tar.gz | ||
73 | |||
74 | The Eclipse tarball is the same as in Enea Linux 4.0. | ||
75 | |||
76 | C. Get Enea Linux up and running on the target: | ||
77 | |||
78 | 4. Get images (kernel, device tree, rootfs) for your target, either the | ||
79 | downloaded precompiled binaries, or by using bitbake to build your own | ||
80 | images from source. NOTE: Building your own images requires that you | ||
81 | first source the init script on the host to set up the build environment. | ||
82 | |||
83 | Generic instruction for how to build your own images: | ||
84 | |||
85 | $ source enea-init-build-env -m <machine> -l <layers> [other options] | ||
86 | $ bitbake enea-image-<name> | ||
87 | |||
88 | 5. Boot Enea Linux on your target. | ||
89 | |||
90 | D. If desired, develop applications: | ||
91 | |||
92 | 6. Install the cross-compilation toolchain (SDK). | ||
93 | |||
94 | 7. Cross-compile application/s for your target and run them in Enea Linux. | ||
95 | |||
96 | 8. Use the Eclipse tools: | ||
97 | Start the eclipse program on host to open the Eclipse IDE, from where | ||
98 | you can customize images, build applications, trace and debug. | ||
99 | See chapter "Using Eclipse in Enea Linux". | ||
100 | |||
101 | |||
102 | DELIVERABLES IN THIS RELEASE | ||
103 | ============================ | ||
104 | |||
105 | Documentation | ||
106 | ------------- | ||
107 | The following Enea Linux manuals are available on the download server, both as | ||
108 | a tarball for installation and in a documentation directory for direct reading: | ||
109 | |||
110 | * README.release (this file) | ||
111 | * Enea Linux Release Information (PDF, HTML) | ||
112 | * Enea Linux User's Guide (PDF, HTML) | ||
113 | * Enea Linux Open Source Report (PDF, HTML) | ||
114 | * Enea Linux Eclipse Open Source Report (PDF, HTML) | ||
115 | |||
116 | |||
117 | Variables in file names | ||
118 | ----------------------- | ||
119 | To simplify this README, long file names have been condensed by using | ||
120 | the following variables: | ||
121 | |||
122 | <release> = 5.0-ppc | ||
123 | <sdkversion> = 5.0-ppc | ||
124 | <target> = t4240rdb-64b | ||
125 | <name> = base or featured | ||
126 | <image> = enea-image-<name> | ||
127 | <sdkimage> = enea-image-featured | ||
128 | <hostarch> = x86_64 | ||
129 | <targetarch> = ppc64e6500 | ||
130 | <libc> = glibc | ||
131 | <distro> = enea | ||
132 | <toolchain> = <distro>-<libc>-<hostarch>-<sdkimage>-<targetarch>-toolchain | ||
133 | |||
134 | |||
135 | Contents on download site | ||
136 | ------------------------- | ||
137 | The Enea Linux download site contains, among other things, precompiled images, | ||
138 | source for bitbake builds, and the latest documentation for the release. | ||
139 | |||
140 | The example below lists the typical contents on the download server. | ||
141 | Some files are present for certain targets only. Other files and directories | ||
142 | might be present, e.g. <file>.sha1 with a unique SHA-1 number for each <file>. | ||
143 | |||
144 | !-- Enea-Linux-<release>.tar.gz /* packed Enea Linux distribution */ | ||
145 | !-- Enea-Linux-doc_<release>.tar.gz /* packed Enea Linux documentation */ | ||
146 | !-- Enea-Linux-Eclipse_<release>.tar.gz/*packed tools:eclipse,yocto-plugins*/ | ||
147 | !-- documentation/ /* Enea Linux documentation */ | ||
148 | !-- patches/ /* critical patches by Enea */ | ||
149 | !-- sources/ /* code and patches */ | ||
150 | !-- <target>/ /* BSP-specific directories for supported hardware */ | ||
151 | ! `-- <image> | ||
152 | ! `-- images/ /* precompiled binaries */ | ||
153 | ! `--<target>/ | ||
154 | ! `-- [u|z]Image-<target>.bin /* kernel image */ | ||
155 | ! `-- [u|z]Image[-<variant>].dtb /* device-tree file */ | ||
156 | ! `-- README_* /* simplified build instruction */ | ||
157 | ! `-- <x>.ext2.gz /* rootfs for RAM-boot */ | ||
158 | ! `-- <x>.manifest /* list of packages in image */ | ||
159 | ! `-- <x>.tar.gz /* rootfs for NFS-boot */ | ||
160 | ! `-- modules[-<target>].tgz /* packed kernel modules */ | ||
161 | ! `-- rpm/ /* .rpm packages */ | ||
162 | ! `-- licenses/ /* license info per package */ | ||
163 | ! `-- sdk/ | ||
164 | ! `- <toolchain>-<sdkversion>.manifest /* list of packages in SDK */ | ||
165 | ! `- <toolchain>-<sdkversion>.sh /* self-extracting archive... | ||
166 | ...installing the cross-compilation toolchain */ | ||
167 | |||
168 | |||
169 | Contents on host after installation | ||
170 | ----------------------------------- | ||
171 | After the installation, you should have, among others, the following files | ||
172 | on your host: | ||
173 | |||
174 | !-- Enea-Linux-<release>/ | ||
175 | ! `-- documentation/ /* Enea Linux documentation */ | ||
176 | ! `-- README.htm /* documentation index */ | ||
177 | ! `-- README.release /* overview of the release */ | ||
178 | ! `-- book-enea-linux-* /* manuals */ | ||
179 | ! `-- poky/ | ||
180 | ! `-- LICENSE /* License file for OpenEmbedded components */ | ||
181 | ! `-- README /* what is Poky, where to send patches */ | ||
182 | ! `-- README.hardware /* how to use Poky with reference machines */ | ||
183 | ! `-- bitbake/ /* bitbake script, lib, doc */ | ||
184 | ! `-- documentation/ /* yocto manuals source and build files */ | ||
185 | ! `-- enea-init-build-env /* script that sets up build env */ | ||
186 | ! `-- oe-init-build-env /* script that partially sets up build env */ | ||
187 | ! /* ...from cmd line but also requires file edit */ | ||
188 | ! `-- meta[<-xxx>]/ /* layers to add to bblayer.conf */ | ||
189 | ! `-- classes/ /* .bbclass files */ | ||
190 | ! `-- conf/ /* conf, inc files; machine (board) definitions */ | ||
191 | ! `-- recipes-<yyy>/ /* .bb, .bbappend, .patch files */ | ||
192 | ! `-- scripts/ /* crosstap, hob, runqemu, a.o. */ | ||
193 | |||
194 | |||
195 | After unpacking the Eclipse tarball to Enea-Linux-<release>, you should also | ||
196 | have the following files on your host: | ||
197 | |||
198 | !-- Enea-Linux-<release>/ | ||
199 | ! `-- eclipse/ /* eclipse binary and plugins (CDT, RSE, SDK, ...) */ | ||
200 | ! `-- yocto-plugins/ /* additional plugins with tools from Yocto ADT */ | ||
201 | |||
202 | |||
203 | HOW TO USE SMART PACKAGE MANAGER | ||
204 | ================================ | ||
205 | |||
206 | Prerequisites | ||
207 | ------------- | ||
208 | - The rpms are located at https://linux.enea.com/RPM/5.0-ppc/ | ||
209 | Note: it's also possible to setup your own webserver and upload rpms there | ||
210 | - Set namesever in the booted target, e.g. | ||
211 | root@t4240rdb-64b:~# vi /etc/resolv.conf | ||
212 | nameserver <ip_addr_of_dns> | ||
213 | |||
214 | Using smart | ||
215 | ------------ | ||
216 | 1. Setup smart channels and update | ||
217 | The following commands will setup channels on target t4240rdb_64b: | ||
218 | # smart channel -y --add all type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/all | ||
219 | # smart channel -y --add t4240rdb_64b type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/t4240rdb_64b | ||
220 | # smart channel -y --add ppc64e6500 type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/ppc64e6500 | ||
221 | # smart channel -y --add lib32_ppce6500 type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/lib32_ppce6500 | ||
222 | |||
223 | Now update Package Manager metadata using this command: | ||
224 | # smart update | ||
225 | |||
226 | You are all set; ready to choose and pick what you need for your development. | ||
227 | |||
228 | 2. Install and remove packages | ||
229 | Smart includes thousands of packages that can be searched. As an example, | ||
230 | let's search for fmc: | ||
231 | # smart search fmc | ||
232 | Loading cache... | ||
233 | Updating cache... ######################################## [100%] | ||
234 | |||
235 | fmc - fmc version git-r2 | ||
236 | fmc-dbg - fmc version git-r2 - Debugging files | ||
237 | fmc-dev - fmc version git-r2 - Development files | ||
238 | fmc-staticdev - fmc version git-r2 - Development files (Static Libraries) | ||
239 | |||
240 | You can use the following command to install a package. As an example, | ||
241 | let's install fmc: | ||
242 | # smart install fmc | ||
243 | |||
244 | You can use the following command to remove a package. As an example, | ||
245 | let's remove fmc: | ||
246 | # smart remove fmc | ||
247 | |||
248 | For more information about smart, please visit their official website at | ||
249 | http://labix.org/smart. | ||
250 | |||
251 | |||
252 | SUPPORT INFORMATION | ||
253 | =================== | ||
254 | |||
255 | Enea can provide more packages on demand and help our customers in customizing | ||
256 | Enea Linux for new hardware. We also fix bugs and contribute patches to Yocto, | ||
257 | and supervise status of reported bugs in the open source community. | ||
258 | You find us at www.enea.com/support. | ||
259 | |||
260 | Enjoy your Enea Linux! | ||