Merge branch 'locking-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[sfrench/cifs-2.6.git] / Documentation / fpga / overview.txt
1 Linux kernel FPGA support
2
3 Alan Tull 2017
4
5 The main point of this project has been to separate the out the upper layers
6 that know when to reprogram a FPGA from the lower layers that know how to
7 reprogram a specific FPGA device.  The intention is to make this manufacturer
8 agnostic, understanding that of course the FPGA images are very device specific
9 themselves.
10
11 The framework in the kernel includes:
12 * low level FPGA manager drivers that know how to program a specific device
13 * the fpga-mgr framework they are registered with
14 * low level FPGA bridge drivers for hard/soft bridges which are intended to
15   be disable during FPGA programming
16 * the fpga-bridge framework they are registered with
17 * the fpga-region framework which associates and controls managers and bridges
18   as reconfigurable regions
19 * the of-fpga-region support for reprogramming FPGAs when device tree overlays
20   are applied.
21
22 I would encourage you the user to add code that creates FPGA regions rather
23 that trying to control managers and bridges separately.