FEX-Emu/linux
1
0
Fork 0
mirror of https://github.com/FEX-Emu/linux.git synced 2024-12-04 22:21:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

mailbox.txt: standardize document format

Browse Source 
Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Add markups for section titles;
- Use :Author: for authorship;
- Mark literal block as such and ident it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2017-05-14 21:06:34 -03:00 committed by Jonathan Corbet
parent 7b001bff46
commit ad98211ba4
1 changed files with 87 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/mailbox.txt
View File

@ -1,5 +1,8 @@
============================
The Common Mailbox Framework The Common Mailbox Framework
Jassi Brar <jaswinder.singh@linaro.org> ============================
:Author: Jassi Brar <jaswinder.singh@linaro.org>
This document aims to help developers write client and controller This document aims to help developers write client and controller
drivers for the API. But before we start, let us note that the drivers for the API. But before we start, let us note that the
@ -13,12 +16,15 @@ similar copies of code written for each platform. Having said that,
nothing prevents the remote f/w to also be Linux based and use the nothing prevents the remote f/w to also be Linux based and use the
same api there. However none of that helps us locally because we only same api there. However none of that helps us locally because we only
ever deal at client's protocol level. ever deal at client's protocol level.
Some of the choices made during implementation are the result of this Some of the choices made during implementation are the result of this
peculiarity of this "common" framework. peculiarity of this "common" framework.
Part 1 - Controller Driver (See include/linux/mailbox_controller.h) Controller Driver (See include/linux/mailbox_controller.h)
==========================================================
Allocate mbox_controller and the array of mbox_chan. Allocate mbox_controller and the array of mbox_chan.
Populate mbox_chan_ops, except peek_data() all are mandatory. Populate mbox_chan_ops, except peek_data() all are mandatory.
@ -30,12 +36,15 @@ the controller driver should set via 'txdone_irq' or 'txdone_poll'
or neither. or neither.
Part 2 - Client Driver (See include/linux/mailbox_client.h) Client Driver (See include/linux/mailbox_client.h)
==================================================
The client might want to operate in blocking mode (synchronously The client might want to operate in blocking mode (synchronously
send a message through before returning) or non-blocking/async mode (submit send a message through before returning) or non-blocking/async mode (submit
a message and a callback function to the API and return immediately). a message and a callback function to the API and return immediately).
::
struct demo_client { struct demo_client {
struct mbox_client cl; struct mbox_client cl;