readme

README.md

@@ -0,0 +1,75 @@
+Before Installing
+=================
+
+You are required to have `gcc`, `make` and `kernel-headers` installed for building the module.
+
+To detect your kernel version run:
+```
+uname -r
+```
+It will output something like
+```
+5.3.11-1-MANJARO
+```
+Then, on Manjaro, run:
+```
+sudo pacman -S linux53-headers
+```
+
+To Install
+==========
+Clone the repo into a github directory in your home folder:
+```
+mkdir github
+cd github
+git clone https://github.com/twifty/aura-gpu.git
+cd aura-gpu
+```
+Then run:
+```
+make install
+```
+The installer will prompt for your sudo password in order to insert the module into the kernel.
+
+After Install
+=============
+The `i2c-dev` module is required:
+```
+sudo pacman -S i2c-tools
+sudo modprobe i2c-dev
+```
+List all i2c devices with:
+```
+sudo i2detect -l
+```
+It will output something like
+```
+i2c-3   smbus           SMBus PIIX4 adapter port 4 at 0b00      SMBus adapter
+i2c-10  i2c             AMDGPU DM i2c hw bus 4                  I2C adapter
+i2c-1   smbus           SMBus PIIX4 adapter port 2 at 0b00      SMBus adapter
+i2c-8   i2c             AMDGPU DM i2c hw bus 2                  I2C adapter
+i2c-6   i2c             AMDGPU DM i2c hw bus 1                  I2C adapter
+i2c-4   i2c             AMDGPU DM i2c hw bus 0                  I2C adapter
+i2c-11  i2c             AURA GPU adapter                        I2C adapter
+i2c-2   smbus           SMBus PIIX4 adapter port 3 at 0b00      SMBus adapter
+i2c-0   smbus           SMBus PIIX4 adapter port 0 at 0b00      SMBus adapter
+i2c-9   i2c             AMDGPU DM i2c hw bus 3                  I2C adapter
+i2c-7   i2c             dmdc                                    I2C adapter
+i2c-5   i2c             dmdc                                    I2C adapter
+```
+Here we can see this module "AURA GPU adapter" is detected as device number 11. We can now scan that device with:
+```
+sudo i2c-detect -y 11
+```
+It should output all clients available on that bus:
+```
+     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
+00:          -- -- -- -- -- 08 -- -- -- -- -- -- --
+10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+20: -- -- -- -- -- -- -- -- -- 29 -- -- -- -- -- --
+30: 30 -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
+60: -- -- -- -- -- -- -- -- 68 -- -- -- -- -- -- --
+70: 70 -- -- -- -- -- -- --   
+```