Merge pull request #51 from jia1sun/iotg_ipu6

iotg mtl-p alpha readme

README.md

@@ -1,15 +1,53 @@
-# Use guide
+# ipu6-camera-hal
 
-## build environment
-ubuntu 21/22
+This repository supports MIPI cameras through the IPU6 on Intel Alder Lake, Raptor Lake and Meteor Lake platforms. There are 4 repositories that provide the complete setup:
 
-## build libcamerahal-xxx.rpm
-1. cd ipu6-camera-hal
-2. mkdir build & cd build
-3. cmake -DCMAKE_BUILD_TYPE=Release -DIPU_VER=ipu6ep
-         -DUSE_PG_LITE_PIPE=ON -DCMAKE_INSTALL_PREFIX=/usr ../
-4. make -j8
-5. make package
+- https://github.com/intel/ipu6-drivers (branch:iotg_ipu6) - kernel drivers for the IPU and sensors
+- https://github.com/intel/ipu6-camera-hal (branch:iotg_ipu6) - HAL for processing of images in userspace
+- https://github.com/intel/ipu6-camera-bins (branch:iotg_ipu6) - IPU firmware and proprietary image processing libraries
+- https://github.com/intel/icamerasrc (branch:icamerasrc_slim_api) - Gstreamer src plugin
 
-## use libcamerahal-xxx.rpm
-rpm -ivh --force --nodeps libcamerahal-xxx.rpm
+
+## Content of this repository:
+- IPU6 HAL
+
+## Build instructions:
+- Dependencies: ipu6-camera-bins
+- Dependencies: libexpat-dev automake libtool libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
+- Build and install:
+
+1. Set IPU6 version for build
+
+    - For Alder Lake and Raptor Lake, set:
+        ```shell
+        IPU6_VER=ipu6ep
+        ```
+
+    - For Meteor Lake, set:
+        ```shell
+        IPU6_VER=ipu6epmtl
+        ```
+
+2. Then continue:
+    ```shell
+    cd ipu6-camera-hal
+    mkdir -p ./build/out/install/usr && cd ./build/
+
+    cmake -DCMAKE_BUILD_TYPE=Release \
+    -DIPU_VER=${IPU6_VER} \
+    -DENABLE_VIRTUAL_IPU_PIPE=OFF \
+    -DUSE_PG_LITE_PIPE=ON \
+    -DUSE_STATIC_GRAPH=OFF \
+    -DCMAKE_INSTALL_PREFIX=/usr ..
+    # if don't want install to /usr, use:
+    # -DCMAKE_INSTALL_PREFIX=./out/install/usr and
+    # export PKG_CONFIG_PATH="$workdir/build/out/install/usr/lib/pkgconfig"
+
+    make -j`nproc`
+    
+    # Install when compile
+    sudo make install
+    ##  Copy ipu6 binary to build environment
+    # Or Install use rpm
+    make package
+    rpm -ivh --force --nodeps libcamhal-xxx.rpm