Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e9d5448e authored by Mitchel Humpherys's avatar Mitchel Humpherys
Browse files

msm: msm_bus: Update docstrings of a few APIs 



The docstrings of some of the MSM bus client APIs have fallen
out-of-date.  Update them to reflect the current implementation.

Change-Id: I7e8ae939e30bdcd35e9389327e0882f3e679218b
Signed-off-by: default avatarMitchel Humpherys <mitchelh@codeaurora.org>
parent 7e80fabd

drivers/platform/msm/msm_bus/msm_bus_client_api.c

+9 −5
Original line number Diff line number Diff line
@@ -101,8 +101,12 @@ EXPORT_SYMBOL(msm_bus_scale_unregister_client); 
/**

 * msm_bus_scale_register() - Register the clients with the msm bus

 * driver

 * @pdata: Platform data of the client, containing src, dest, ab, ib.

 * Return non-zero value in case of success, 0 in case of failure.

 *

 * @mas: Master ID

 * @slv: Slave ID

 * @name: descriptive name for this client

 * @active_only: Whether or not this bandwidth vote should only be

 *               effective while the application processor is active.

 *

 * Client data contains the vectors specifying arbitrated bandwidth (ab)

 * and instantaneous bandwidth (ib) requested between a particular
@@ -126,9 +130,9 @@ EXPORT_SYMBOL(msm_bus_scale_register); 
 * msm_bus_scale_client_update_bw() - Update the request for bandwidth

 * from a particular client

 *

 * cl: Handle to the client

 * index: Index into the vector, to which the bw and clock values need to be

 * updated

 * @cl: Handle to the client

 * @ab: Arbitrated bandwidth being requested

 * @ib: Instantaneous bandwidth being requested

 */

int msm_bus_scale_update_bw(struct msm_bus_client_handle *cl, u64 ab, u64 ib)

{