linux/drivers/soc/qcom
Douglas Anderson e40b0c1628 soc: qcom: rpmh-rsc: A lot of comments
I've been pouring through the rpmh-rsc code and trying to understand
it.  Document everything to the best of my ability.  All documentation
here is strictly from code analysis--no actual knowledge of the
hardware was used.  If something is wrong in here I either
misunderstood the code, had a typo, or the code has a bug in it
leading to my incorrect understanding.

In a few places here I have documented things that don't make tons of
sense.  A future patch will try to address this.  While this means I'm
adding comments / todos and then later fixing them in the series, it
seemed more urgent to get things documented first so that people could
understand the later patches.

Any comments I adjusted I also tried to make match kernel-doc better.
Specifically:
- kernel-doc says do not leave a blank line between the function
  description and the arguments
- kernel-doc examples always have things starting w/ a capital and
  ending with a period.

This should be a no-op.  It's just comment changes.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
Reviewed-by: Maulik Shah <mkshah@codeaurora.org>
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
Link: https://lore.kernel.org/r/20200413100321.v4.6.I52653eb85d7dc8981ee0dafcd0b6cc0f273e9425@changeid
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2020-04-13 22:09:35 -07:00
..
apr.c soc: qcom: apr: Add avs/audio tracking functionality 2020-03-14 22:38:50 -07:00
cmd-db.c soc: qcom: cmd-db: Add debugfs dumping file 2020-04-13 18:10:11 -07:00
glink_ssr.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 284 2019-06-05 17:36:37 +02:00
Kconfig soc: qcom: Fix QCOM_APR dependencies 2020-03-16 15:07:19 -07:00
llcc-qcom.c soc: qcom: llcc: Add configuration data for SC7180 2019-10-20 19:15:20 -07:00
Makefile soc: qcom: Introduce Protection Domain Restart helpers 2020-03-14 22:38:42 -07:00
mdt_loader.c remoteproc updates for v5.3 2019-07-17 11:44:41 -07:00
ocmem.c soc: qcom: add OCMEM driver 2019-10-07 08:17:33 -07:00
pdr_interface.c soc: qcom: pdr: Avoid uninitialized use of found in pdr_indication_cb 2020-03-16 14:56:57 -07:00
pdr_internal.h soc: qcom: Introduce Protection Domain Restart helpers 2020-03-14 22:38:42 -07:00
qcom_aoss.c soc: qcom: aoss: Read back before triggering the IRQ 2020-02-13 21:18:16 -08:00
qcom_gsbi.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 409 2019-06-05 17:37:14 +02:00
qcom-geni-se.c soc: qcom: geni: Provide parameter error checking 2019-09-06 11:08:08 +02:00
qmi_encdec.c soc: qcom: Introduce QMI encoder/decoder 2017-12-20 15:38:34 -06:00
qmi_interface.c soc: qcom: qmi: Return EPROBE_DEFER if no address family 2019-12-10 22:44:34 -08:00
rmtfs_mem.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 284 2019-06-05 17:36:37 +02:00
rpmh-internal.h soc: qcom: rpmh-rsc: A lot of comments 2020-04-13 22:09:35 -07:00
rpmh-rsc.c soc: qcom: rpmh-rsc: A lot of comments 2020-04-13 22:09:35 -07:00
rpmh.c soc: qcom: rpmh: Invoke rpmh_flush() for dirty caches 2020-04-13 18:26:07 -07:00
rpmhpd.c soc: qcom: rpmhpd: Set 'active_only' for active only power domains 2020-01-07 15:19:30 -08:00
rpmpd.c soc: qcom: rpmpd: Add rpm power domains for msm8976 2019-10-06 22:51:32 -07:00
smd-rpm.c soc: qcom: smd-rpm: Add MSM8976 compatible 2019-10-04 21:20:10 -07:00
smem_state.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 284 2019-06-05 17:36:37 +02:00
smem.c soc: qcom: smem: Update max processor count 2019-08-21 15:58:01 -07:00
smp2p.c soc: qcom: smp2p: Delete an error message in qcom_smp2p_probe() 2020-04-13 18:10:12 -07:00
smsm.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 284 2019-06-05 17:36:37 +02:00
socinfo.c soc: qcom: socinfo: add missing soc_id sysfs entry 2020-04-13 18:10:10 -07:00
spm.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 284 2019-06-05 17:36:37 +02:00
trace-rpmh.h drivers: qcom: rpmh-rsc: log RPMH requests in FTRACE 2018-07-21 13:32:31 -05:00
wcnss_ctrl.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 284 2019-06-05 17:36:37 +02:00