Changeset b7fd2a0 in mainline for uspace/lib/drv/include/audio_pcm_iface.h

Timestamp:

2018-01-13T03:10:29Z (8 years ago)

Author:

Jiří Zárevúcky <zarevucky.jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

a53ed3a

Parents:

36f0738

Message:

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
<sup>git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`</sup>

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.

File:

• uspace/lib/drv/include/audio_pcm_iface.h (modified) (1 diff)

uspace/lib/drv/include/audio_pcm_iface.h

@@ -80 +80 @@
 void audio_pcm_close(audio_pcm_sess_t *);
 
-int audio_pcm_get_info_str(audio_pcm_sess_t *, const char **);
-int audio_pcm_test_format(audio_pcm_sess_t *, unsigned *, unsigned *,
+errno_t audio_pcm_get_info_str(audio_pcm_sess_t *, const char **);
+errno_t audio_pcm_test_format(audio_pcm_sess_t *, unsigned *, unsigned *,
     pcm_sample_format_t *);
-int audio_pcm_query_cap(audio_pcm_sess_t *, audio_cap_t, sysarg_t *);
-int audio_pcm_register_event_callback(audio_pcm_sess_t *,
+errno_t audio_pcm_query_cap(audio_pcm_sess_t *, audio_cap_t, sysarg_t *);
+errno_t audio_pcm_register_event_callback(audio_pcm_sess_t *,
     async_port_handler_t, void *);
-int audio_pcm_unregister_event_callback(audio_pcm_sess_t *);
+errno_t audio_pcm_unregister_event_callback(audio_pcm_sess_t *);
 
-int audio_pcm_get_buffer(audio_pcm_sess_t *, void **, size_t *);
-int audio_pcm_get_buffer_pos(audio_pcm_sess_t *, size_t *);
-int audio_pcm_release_buffer(audio_pcm_sess_t *);
+errno_t audio_pcm_get_buffer(audio_pcm_sess_t *, void **, size_t *);
+errno_t audio_pcm_get_buffer_pos(audio_pcm_sess_t *, size_t *);
+errno_t audio_pcm_release_buffer(audio_pcm_sess_t *);
 
-int audio_pcm_start_playback_fragment(audio_pcm_sess_t *, unsigned,
+errno_t audio_pcm_start_playback_fragment(audio_pcm_sess_t *, unsigned,
     unsigned, unsigned, pcm_sample_format_t);
-int audio_pcm_last_playback_fragment(audio_pcm_sess_t *);
+errno_t audio_pcm_last_playback_fragment(audio_pcm_sess_t *);
 
-int audio_pcm_start_playback(audio_pcm_sess_t *,
+errno_t audio_pcm_start_playback(audio_pcm_sess_t *,
     unsigned, unsigned, pcm_sample_format_t);
-int audio_pcm_stop_playback_immediate(audio_pcm_sess_t *);
-int audio_pcm_stop_playback(audio_pcm_sess_t *);
+errno_t audio_pcm_stop_playback_immediate(audio_pcm_sess_t *);
+errno_t audio_pcm_stop_playback(audio_pcm_sess_t *);
 
-int audio_pcm_start_capture_fragment(audio_pcm_sess_t *, unsigned,
+errno_t audio_pcm_start_capture_fragment(audio_pcm_sess_t *, unsigned,
     unsigned, unsigned, pcm_sample_format_t);
-int audio_pcm_last_capture_fragment(audio_pcm_sess_t *);
+errno_t audio_pcm_last_capture_fragment(audio_pcm_sess_t *);
 
-int audio_pcm_start_capture(audio_pcm_sess_t *,
+errno_t audio_pcm_start_capture(audio_pcm_sess_t *,
     unsigned, unsigned, pcm_sample_format_t);
-int audio_pcm_stop_capture_immediate(audio_pcm_sess_t *);
-int audio_pcm_stop_capture(audio_pcm_sess_t *);
+errno_t audio_pcm_stop_capture_immediate(audio_pcm_sess_t *);
+errno_t audio_pcm_stop_capture(audio_pcm_sess_t *);
 
 /** Audio pcm communication interface. */
 typedef struct {
-        int (*get_info_str)(ddf_fun_t *, const char **);
-        int (*test_format)(ddf_fun_t *, unsigned *, unsigned *,
+        errno_t (*get_info_str)(ddf_fun_t *, const char **);
+        errno_t (*test_format)(ddf_fun_t *, unsigned *, unsigned *,
             pcm_sample_format_t *);
         unsigned (*query_cap)(ddf_fun_t *, audio_cap_t);
-        int (*get_buffer_pos)(ddf_fun_t *, size_t *);
-        int (*get_buffer)(ddf_fun_t *, void **, size_t *);
-        int (*release_buffer)(ddf_fun_t *);
-        int (*set_event_session)(ddf_fun_t *, async_sess_t *);
+        errno_t (*get_buffer_pos)(ddf_fun_t *, size_t *);
+        errno_t (*get_buffer)(ddf_fun_t *, void **, size_t *);
+        errno_t (*release_buffer)(ddf_fun_t *);
+        errno_t (*set_event_session)(ddf_fun_t *, async_sess_t *);
         async_sess_t * (*get_event_session)(ddf_fun_t *);
-        int (*start_playback)(ddf_fun_t *, unsigned,
+        errno_t (*start_playback)(ddf_fun_t *, unsigned,
             unsigned, unsigned, pcm_sample_format_t);
-        int (*stop_playback)(ddf_fun_t *, bool);
-        int (*start_capture)(ddf_fun_t *, unsigned,
+        errno_t (*stop_playback)(ddf_fun_t *, bool);
+        errno_t (*start_capture)(ddf_fun_t *, unsigned,
             unsigned, unsigned, pcm_sample_format_t);
-        int (*stop_capture)(ddf_fun_t *, bool);
+        errno_t (*stop_capture)(ddf_fun_t *, bool);
 } audio_pcm_iface_t;