linux.git/Documentation/driver-api/fpga, branch v5.10

docs: fpga: replace :c:member: macros

2020-10-15T05:49:43+00:00

Those macros are not doing the right thing with Sphinx 3,
causing parse errors:

	./Documentation/driver-api/fpga/fpga-mgr.rst:104: WARNING: Unparseable C cross-reference: 'fpga_manager->state'
	Invalid C declaration: Expected end of definition. [error at 12]
	  fpga_manager->state
	  ------------^
	./Documentation/driver-api/fpga/fpga-programming.rst:18: WARNING: Unparseable C cross-reference: 'fpga_region->info'
	Invalid C declaration: Expected end of definition. [error at 11]
	  fpga_region->info
	  -----------^
	./Documentation/driver-api/fpga/fpga-region.rst:62: WARNING: Unparseable C cross-reference: 'fpga_region->bridge_list'
	Invalid C declaration: Expected end of definition. [error at 11]
	  fpga_region->bridge_list
	  -----------^
	./Documentation/driver-api/fpga/fpga-region.rst:62: WARNING: Unparseable C cross-reference: 'fpga_region->get_bridges'
	Invalid C declaration: Expected end of definition. [error at 11]
	  fpga_region->get_bridges
	  -----------^

Replace them by :c:expr:, with does what's desired.

Reviewed-by: Moritz Fischer 
Signed-off-by: Mauro Carvalho Chehab

docs: get rid of :c:type explicit declarations for structs

2020-10-15T05:49:40+00:00

The :c:type:`foo` only works properly with structs before
Sphinx 3.x.

On Sphinx 3.x, structs should now be declared using the
.. c:struct, and referenced via :c:struct tag.

As we now have the automarkup.py macro, that automatically
convert:
	struct foo

into cross-references, let's get rid of that, solving
several warnings when building docs with Sphinx 3.x.

Reviewed-by: André Almeida  # blk-mq.rst
Reviewed-by: Takashi Iwai  # sound
Reviewed-by: Mike Rapoport 
Reviewed-by: Greg Kroah-Hartman 
Signed-off-by: Mauro Carvalho Chehab

Fpga: Documentation: Replace deprecated :c:func: Usage

2020-08-24T23:19:06+00:00

Replace :c:func: with func() as the previous usage is deprecated.

Signed-off-by: Puranjay Mohan 
Link: https://lore.kernel.org/r/20200812180224.24810-1-puranjay12@gmail.com
Signed-off-by: Jonathan Corbet

docs: fpga: document programming fpgas using regions

2018-10-16T09:13:50+00:00

Clarify the intention that interfaces and upper layers use
regions rather than managers directly.

Rearrange API documentation to better group the API functions
used to create FPGA mgr/bridge/regions and the API used for
programming FPGAs.

Signed-off-by: Alan Tull 
Suggested-by: Federico Vaga 
Acked-by: Moritz Fischer 
Signed-off-by: Greg Kroah-Hartman

fpga: add devm_fpga_region_create

2018-10-16T09:13:50+00:00

Add devm_fpga_region_create() which is the
managed version of fpga_region_create().

Change current region drivers to use
devm_fpga_region_create().

Signed-off-by: Alan Tull 
Suggested-by: Federico Vaga 
Acked-by: Moritz Fischer 
Signed-off-by: Greg Kroah-Hartman

fpga: bridge: add devm_fpga_bridge_create

2018-10-16T09:13:50+00:00

Add devm_fpga_bridge_create() which is the managed
version of fpga_bridge_create().

Change current bridge drivers to use
devm_fpga_bridge_create().

Signed-off-by: Alan Tull 
Suggested-by: Federico Vaga 
Acked-by: Moritz Fischer 
Signed-off-by: Greg Kroah-Hartman

fpga: mgr: add devm_fpga_mgr_create

2018-10-16T09:13:50+00:00

Add devm_fpga_mgr_create() which is the managed
version of fpga_mgr_create().

Change current FPGA manager drivers to use
devm_fpga_mgr_create()

Signed-off-by: Alan Tull 
Suggested-by: Federico Vaga 
Acked-by: Moritz Fischer 
Signed-off-by: Greg Kroah-Hartman

docs: fpga: document fpga manager flags

2018-09-30T15:49:55+00:00

Add flags #defines to kerneldoc documentation in a
useful place.

Signed-off-by: Alan Tull 
Acked-by: Moritz Fischer 
Signed-off-by: Greg Kroah-Hartman

Documentation: fpga: cleanup

2018-07-07T14:56:09+00:00

Minor fixes including:

* fix some typos
* correct use of a/an
* rephrase explanation of .state ops function
* s/re-use/reuse/ (use only one spelling of 'reuse' in these docs)
* s/cpu/CPU/

Signed-off-by: Alan Tull 
Acked-by: Randy Dunlap 
Signed-off-by: Greg Kroah-Hartman

documentation: fpga: move fpga-region.txt to driver-api

2018-05-25T16:23:56+00:00

Move Documentation/fpga/fpga-region.txt to
driver-api/fpga/fpga-region.rst.  Including:
 - Add it to driver-api/fpga/index.rst
 - Formatting changes to build cleanly as ReST documentation
 - Some rewrites for better flow as a ReST doc such as moving
   API reference to the end of the doc
 - Rewrite API reference section to refer to kernel-doc
   documentation in fpga-region.c driver code

Signed-off-by: Alan Tull 
Signed-off-by: Greg Kroah-Hartman