summaryrefslogtreecommitdiffstats
path: root/pcilib/property.h
diff options
context:
space:
mode:
authorSuren A. Chilingaryan <csa@suren.me>2015-10-22 15:57:59 +0200
committerSuren A. Chilingaryan <csa@suren.me>2015-10-22 15:57:59 +0200
commita0fe5cdea15bca52d3b101a88c11cb160ef08b2f (patch)
treee40e5d90ed013e33617931b049c5039e37a1f51f /pcilib/property.h
parentee18798c64c6e40433413b73bf07bbe027a9cc6e (diff)
downloadpcitool-a0fe5cdea15bca52d3b101a88c11cb160ef08b2f.tar.gz
pcitool-a0fe5cdea15bca52d3b101a88c11cb160ef08b2f.tar.bz2
pcitool-a0fe5cdea15bca52d3b101a88c11cb160ef08b2f.tar.xz
pcitool-a0fe5cdea15bca52d3b101a88c11cb160ef08b2f.zip
Documentation update
Diffstat (limited to 'pcilib/property.h')
-rw-r--r--pcilib/property.h23
1 files changed, 12 insertions, 11 deletions
diff --git a/pcilib/property.h b/pcilib/property.h
index 75ec053..c62e340 100644
--- a/pcilib/property.h
+++ b/pcilib/property.h
@@ -5,30 +5,31 @@
extern "C" {
#endif
/**
- * This is an internal function used to add property view for all model registers. It is automatically
+ * This is an internal function used to add property views for all model registers. It is automatically
* called from pcilib_add_registers and should not be called by the users. On error no new views are
* initalized.
- * @param[in,out] ctx - pcilib context
- * @param[in] n - number of views to initialize.
- * @param[in] banks - array containing a bank id for each of the considered registers
- * @param[in] desc - register descriptions
- * @return - error or 0 on success
+ * @param[in,out] ctx - pcilib context
+ * @param[in] n - number of views to initialize.
+ * @param[in] banks - array containing a bank id for each of the considered registers
+ * @param[in] registers - register descriptions
+ * @return - error or 0 on success
*/
int pcilib_add_properties_from_registers(pcilib_t *ctx, size_t n, const pcilib_register_bank_t *banks, const pcilib_register_description_t *registers);
/**
+ * This is an internal function used to add registers providing alternative access to values of the properties.
* To reduce number of required interfaces, some of the property views may be also mapped into the
* model as registers. The client application, then, is able to use either register or property APIs
* to access them. This is an internal function which processes the supplied views, finds which views
* have to be mapped in the register space, and finally pushes corresponding registers into the model.
* The function is automatically called from pcilib_add_views and should never be called by the user.
* On error no new registers are added.
- * @param[in,out] ctx - pcilib context
- * @param[in] n - number of views to analyze.
- * @param[in] view_ctx - views to analyze
- * @param[in] view - array of pointers to corresponding view descriptions
- * @return - error or 0 on success
+ * @param[in,out] ctx - pcilib context
+ * @param[in] n - number of views to analyze.
+ * @param[in] view_ctx - views to analyze
+ * @param[in] view - array of pointers to corresponding view descriptions
+ * @return - error or 0 on success
*/
int pcilib_add_registers_from_properties(pcilib_t *ctx, size_t n, pcilib_view_context_t* const *view_ctx, pcilib_view_description_t* const *view);