Document return values of bcm_host_get_peripheral_* functions for clarity

raspberrypi / userland

Source code for ARM side libraries for interfacing to Raspberry Pi GPU.

BSD 3-Clause "New" or "Revised" License

2.05k stars 1.09k forks source link

Document return values of bcm_host_get_peripheral_* functions for clarity #726

Open DanielIndictor opened 2 years ago

DanielIndictor commented 2 years ago

I was confused by why the datasheet reported a different value for the base address of the peripherals than this function returned, so I had to read the implementation, trace that to the dtb source code, and find the appropriate line in the kernel code. Hopefully documenting this will save somebody some time in the future!