plugins: expand the typedef kernel-docs for translation

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20210312172821.31647-8-alex.bennee@linaro.org>
This commit is contained in:
Alex Bennée 2021-03-12 17:28:14 +00:00
parent c4f19122d9
commit 83b9c2bfa4

View File

@ -103,14 +103,14 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,
* typedef qemu_plugin_simple_cb_t - simple callback * typedef qemu_plugin_simple_cb_t - simple callback
* @id: the unique qemu_plugin_id_t * @id: the unique qemu_plugin_id_t
* *
* This call-back passes no information aside from the unique @id. * This callback passes no information aside from the unique @id.
*/ */
typedef void (*qemu_plugin_simple_cb_t)(qemu_plugin_id_t id); typedef void (*qemu_plugin_simple_cb_t)(qemu_plugin_id_t id);
/** /**
* typedef qemu_plugin_udata_cb_t - callback with user data * typedef qemu_plugin_udata_cb_t - callback with user data
* @id: the unique qemu_plugin_id_t * @id: the unique qemu_plugin_id_t
* @userdata: a pointer to some user data supplied when the call-back * @userdata: a pointer to some user data supplied when the callback
* was registered. * was registered.
*/ */
typedef void (*qemu_plugin_udata_cb_t)(qemu_plugin_id_t id, void *userdata); typedef void (*qemu_plugin_udata_cb_t)(qemu_plugin_id_t id, void *userdata);
@ -126,7 +126,7 @@ typedef void (*qemu_plugin_vcpu_simple_cb_t)(qemu_plugin_id_t id,
/** /**
* typedef qemu_plugin_vcpu_udata_cb_t - vcpu callback * typedef qemu_plugin_vcpu_udata_cb_t - vcpu callback
* @vcpu_index: the current vcpu context * @vcpu_index: the current vcpu context
* @userdata: a pointer to some user data supplied when the call-back * @userdata: a pointer to some user data supplied when the callback
* was registered. * was registered.
*/ */
typedef void (*qemu_plugin_vcpu_udata_cb_t)(unsigned int vcpu_index, typedef void (*qemu_plugin_vcpu_udata_cb_t)(unsigned int vcpu_index,
@ -202,11 +202,9 @@ void qemu_plugin_register_vcpu_idle_cb(qemu_plugin_id_t id,
void qemu_plugin_register_vcpu_resume_cb(qemu_plugin_id_t id, void qemu_plugin_register_vcpu_resume_cb(qemu_plugin_id_t id,
qemu_plugin_vcpu_simple_cb_t cb); qemu_plugin_vcpu_simple_cb_t cb);
/* /** struct qemu_plugin_tb - Opaque handle for a translation block */
* Opaque types that the plugin is given during the translation and
* instrumentation phase.
*/
struct qemu_plugin_tb; struct qemu_plugin_tb;
/** struct qemu_plugin_insn - Opaque handle for a translated instruction */
struct qemu_plugin_insn; struct qemu_plugin_insn;
enum qemu_plugin_cb_flags { enum qemu_plugin_cb_flags {
@ -221,6 +219,14 @@ enum qemu_plugin_mem_rw {
QEMU_PLUGIN_MEM_RW, QEMU_PLUGIN_MEM_RW,
}; };
/**
* typedef qemu_plugin_vcpu_tb_trans_cb_t - translation callback
* @id: unique plugin id
* @tb: opaque handle used for querying and instrumenting a block.
*/
typedef void (*qemu_plugin_vcpu_tb_trans_cb_t)(qemu_plugin_id_t id,
struct qemu_plugin_tb *tb);
/** /**
* qemu_plugin_register_vcpu_tb_trans_cb() - register a translate cb * qemu_plugin_register_vcpu_tb_trans_cb() - register a translate cb
* @id: plugin ID * @id: plugin ID
@ -233,9 +239,6 @@ enum qemu_plugin_mem_rw {
* callbacks to be triggered when the block or individual instruction * callbacks to be triggered when the block or individual instruction
* executes. * executes.
*/ */
typedef void (*qemu_plugin_vcpu_tb_trans_cb_t)(qemu_plugin_id_t id,
struct qemu_plugin_tb *tb);
void qemu_plugin_register_vcpu_tb_trans_cb(qemu_plugin_id_t id, void qemu_plugin_register_vcpu_tb_trans_cb(qemu_plugin_id_t id,
qemu_plugin_vcpu_tb_trans_cb_t cb); qemu_plugin_vcpu_tb_trans_cb_t cb);