machine: Add readme for ebisu
[AGL/meta-agl.git] / templates / machine / ebisu / README_machine_ebisu.md
1 ---
2 description: machine ebisu
3 author: <undefined>
4 ---
5 ## Machine 'ebisu'
6
7 ### Prepare the build
8
9 Before building the AGL distribution for Renesas 'ebisu' board, it is necessary to prepare the environnement. See [AGL Doc - Initializing Your Build Environment](https://docs.automotivelinux.org/docs/en/master/getting_started/reference/getting-started/image-workflow-initialize-build-environment.html) before going to the next step.
10
11 The 'ebisu' board need some specifics binaries in order to build. These binaries contain Graphics support, specific drivers... They are only delivered by Renesas.
12 Before setting up the build with `meta-agl/scripts/aglsetup.sh`, the environment variable `EBISU_BIN_PATH` need to be set. This variable specify the path to a folder which contains all ebisu's binaries zip files.
13
14 Moreover, it's possible to launch a custom bash script during the setup. This optional step will be called at the end of the `aglsetup.sh` sequence. This can be used to add a specific configuration to the official setup or add a hotfix.
15
16 Example:
17 ```bash
18 $ cd $AGL_TOP
19 $ export EBISU_BIN_PATH=/home/user/Downloads/ebisu_binaries
20 $ export CUSTOM_RENESAS_CONFIG_SCRIPT=/path/to/my/Renesas_custom_setup_ebisu.sh #optional
21 $ source meta-agl/scripts/aglsetup.sh -m ebisu agl-demo -f
22 ```
23
24 ### Launch the build
25
26 When your environnment is ready, you can launch the AGL build with `bitbake` :
27
28 ```bash
29 $ cd $AGL_TOP
30 $ bitbake agl-demo-platform
31 ```
32
33 ### Debugging the board
34
35 To debug the ebisu board, the PC should be connected to the CN25 USB serial port.
36 And the serial communication's protocol of the terminal software on the PC should be set as follows:
37
38 Parameter | Value
39 ---      | ---
40 Transfer rate | 115200 bps
41 Data length | 8 bits
42 Parity | Not in use
43 Stop bit | 1 bit
44 Flow control | Not provided