srd: last public/private fix, and docs for all publis functions.

[libsigrokdecode.git] / controller.c

diff --git a/controller.c b/controller.c
index 8b9f793750bc7c9658c5e7e3fd51fcdd0ea3d105..05dbf3eb8bbfea6609d24cc446fc87303c249ee1 100644 (file)
--- a/controller.c
+++ b/controller.c
@@ -332,6 +332,7 @@ static gint compare_probe_id(struct srd_probe *a, char *probe_id)
  * @param probes A GHashTable of probes to set. Key is probe name, value is
  *               the probe number. Samples passed to this instance will be
  *               arranged in this order.
+ *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
 SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
@@ -403,6 +404,7 @@ SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
  * @param id Decoder 'id' field.
  * @param options GHashtable of options which override the defaults set in
  *                the decoder class.
+ *
  * @return Pointer to a newly allocated struct srd_decoder_inst, or
  *         NULL in case of failure.
  */
@@ -469,6 +471,14 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
        return di;
 }
 
+/**
+ * Stack a decoder instance on top of another.
+ *
+ * @param di_from The instance to move.
+ * @param di_to The instance on top of which di_from will be stacked.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
                               struct srd_decoder_inst *di_to)
 {
@@ -526,7 +536,7 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
  *
  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
  */
-SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
+SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
                                                              PyObject *obj)
 {
        GSList *l;
@@ -544,7 +554,7 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
        return di;
 }
 
-SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
+SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
 {
        PyObject *py_name, *py_res;
        GSList *l;
@@ -593,7 +603,7 @@ SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_API int srd_inst_decode(uint64_t start_samplenum,
+SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
                                struct srd_decoder_inst *di,
                                uint8_t *inbuf, uint64_t inbuflen)
 {
@@ -645,7 +655,7 @@ SRD_API int srd_inst_decode(uint64_t start_samplenum,
        return SRD_OK;
 }
 
-SRD_API void srd_inst_free(struct srd_decoder_inst *di)
+SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
 {
        GSList *l;
        struct srd_pd_output *pdo;
@@ -664,7 +674,7 @@ SRD_API void srd_inst_free(struct srd_decoder_inst *di)
        g_slist_free(di->pd_output);
 }
 
-SRD_API void srd_inst_free_all(GSList *stack)
+SRD_PRIV void srd_inst_free_all(GSList *stack)
 {
        GSList *l;
        struct srd_decoder_inst *di;
@@ -682,6 +692,17 @@ SRD_API void srd_inst_free_all(GSList *stack)
        }
 }
 
+/**
+ * Start a decoding session.
+ *
+ * Decoders, instances and stack must have been prepared beforehand.
+ *
+ * @param num_probes The number of probes which the incoming feed will contain.
+ * @param unitsize The number of bytes per sample in the incoming feed.
+ * @param The samplerate of the incoming feed.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 {
        PyObject *args;
@@ -715,8 +736,16 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
        return ret;
 }
 
-/* Feed logic samples to decoder session. */
-SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
+/**
+ * Feed a chunk of logic sample data to a running decoder session.
+ *
+ * @param start_samplenum The sample number of the first sample in this chunk.
+ * @param inbuf Pointer to sample data.
+ * @param inbuf Length in bytes of the buffer.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
+SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
                             uint64_t inbuflen)
 {
        GSList *d;
@@ -735,6 +764,18 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
        return SRD_OK;
 }
 
+/**
+ * Register a decoder output callback function.
+ *
+ * The function will be called when a protocol decoder sends output back
+ * to the PD controller (except for Python objects, which only go up the
+ * stack).
+ *
+ * @param output_type The output type this callback will receive. Only one
+ * callback per output type can be registered.
+ * @param cb The function to call.
+ * @param user_data Unused.
+ */
 SRD_API int srd_register_callback(int output_type,
                                  srd_pd_output_callback_t cb, void *user_data)
 {
@@ -755,7 +796,7 @@ SRD_API int srd_register_callback(int output_type,
        return SRD_OK;
 }
 
-SRD_API void *srd_find_callback(int output_type)
+SRD_PRIV void *srd_find_callback(int output_type)
 {
        GSList *l;
        struct srd_pd_callback *pd_cb;