linux-toradex.git/Documentation/driver-api/fpga, branch v6.6-rc3

docs: fpga: mgr: document parse_header() callback

2022-06-24T04:12:24+00:00

Document newly introduced fpga_manager_ops callback parse_header() and
flag skip_header along with header_size and data_size fields of struct
fpga_image_info.

Signed-off-by: Ivan Bornyakov 
Acked-by: Xu Yilun 
Link: https://lore.kernel.org/r/20220623163248.3672-3-i.bornyakov@metrotek.ru
Signed-off-by: Xu Yilun

fpga: region: Use standard dev_release for class driver

2021-11-28T22:02:41+00:00

The FPGA region class driver data structure is being treated as a
managed resource instead of using the standard dev_release call-back
function to release the class data structure. This change removes the
managed resource code and combines the create() and register()
functions into a single register() or register_full() function.

The register_full() function accepts an info data structure to provide
flexibility in passing optional parameters. The register() function
supports the current parameter list for users that don't require the
use of optional parameters.

Signed-off-by: Russ Weight 
Reviewed-by: Xu Yilun 
Acked-by: Xu Yilun 
Signed-off-by: Moritz Fischer

fpga: bridge: Use standard dev_release for class driver

2021-11-28T22:02:13+00:00

The FPGA bridge class driver data structure is being treated as a
managed resource instead of using the standard dev_release call-back
function to release the class data structure. This change removes
the managed resource code and combines the create() and register()
functions into a single register() function.

Signed-off-by: Russ Weight 
Reviewed-by: Xu Yilun 
Acked-by: Xu Yilun 
Signed-off-by: Moritz Fischer

fpga: mgr: Use standard dev_release for class driver

2021-11-28T21:59:13+00:00

The FPGA manager class driver data structure is being treated as a
managed resource instead of using the standard dev_release call-back
function to release the class data structure. This change removes
the managed resource code for the freeing of the class data structure
and combines the create() and register() functions into a single
register() or register_full() function.

The register_full() function accepts an info data structure to provide
flexibility in passing optional parameters. The register() function
supports the current parameter list for users that don't require the
use of optional parameters.

The devm_fpga_mgr_register() function is retained, and the
devm_fpga_mgr_register_full() function is added.

Signed-off-by: Russ Weight 
Reviewed-by: Xu Yilun 
Acked-by: Xu Yilun 
Signed-off-by: Moritz Fischer

docs: driver-api: fpga: avoid using UTF-8 chars

2021-07-22T02:54:21+00:00

While UTF-8 characters can be used at the Linux documentation,
the best is to use them only when ASCII doesn't offer a good replacement.
So, replace the occurences of the following UTF-8 characters:

	- U+2014 ('—'): EM DASH

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

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