X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Falsa%2Falsa.c;h=994183fc1dd20ce16cd60500927f89e76c71cb47;hb=d261dbbfcc73;hp=b41d8ed3536714f83e5a2fb695c3801e538c72e7;hpb=58330ab892c64461a73471a197fd8816630944a9;p=libsigrok.git

diff --git a/hardware/alsa/alsa.c b/hardware/alsa/alsa.c
index b41d8ed3..994183fc 100644
--- a/hardware/alsa/alsa.c
+++ b/hardware/alsa/alsa.c
@@ -18,26 +18,47 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+/* Note: This driver doesn't compile, analog support in sigrok is WIP. */
+
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>
-#include <sigrok.h>
 #include <alsa/asoundlib.h>
-#include "config.h"
+#include "sigrok.h"
+#include "sigrok-internal.h"
 
 #define NUM_PROBES 2
 #define SAMPLE_WIDTH 16
 #define AUDIO_DEV "plughw:0,0"
 
-static int capabilities[] = {
-	HWCAP_SAMPLERATE,
-	HWCAP_LIMIT_SAMPLES,
-	HWCAP_CONTINUOUS,
+struct sr_analog_probe {
+	uint8_t att;
+	uint8_t res;    /* Needs to be a power of 2, FIXME */
+	uint16_t val;   /* Max hardware ADC width is 16bits */
+};
+
+struct sr_analog_sample {
+	uint8_t num_probes; /* Max hardware probes is 256 */
+	struct sr_analog_probe probes[];
 };
 
-static GSList *device_instances = NULL;
+static int hwcaps[] = {
+	SR_HWCAP_SAMPLERATE,
+	SR_HWCAP_LIMIT_SAMPLES,
+	SR_HWCAP_CONTINUOUS,
+};
+
+/* TODO: Which probe names/numbers to use? */
+static const char *probe_names[NUM_PROBES + 1] = {
+	"0",
+	"1",
+	NULL,
+};
 
-struct alsa {
+static GSList *dev_insts = NULL;
+
+/* Private, per-device-instance driver context. */
+struct context {
 	uint64_t cur_rate;
 	uint64_t limit_samples;
 	snd_pcm_t *capture_handle;
@@ -45,324 +66,347 @@ struct alsa {
 	gpointer session_id;
 };
 
-static int hw_init(char *deviceinfo)
+static int hw_init(const char *devinfo)
 {
-	struct sigrok_device_instance *sdi;
-	struct alsa *alsa;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
 
 	/* Avoid compiler warnings. */
-	deviceinfo = deviceinfo;
+	(void)devinfo;
 
-	alsa = malloc(sizeof(struct alsa));
-	if (!alsa)
+	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
+		sr_err("alsa: %s: ctx malloc failed", __func__);
 		return 0;
-	memset(alsa, 0, sizeof(struct alsa));
+	}
 
-	sdi = sigrok_device_instance_new(0, ST_ACTIVE, "alsa", NULL, NULL);
-	if (!sdi)
-		goto free_alsa;
+	if (!(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, "alsa", NULL, NULL))) {
+		sr_err("alsa: %s: sdi was NULL", __func__);
+		goto free_ctx;
+	}
 
-	sdi->priv = alsa;
+	sdi->priv = ctx;
 
-	device_instances = g_slist_append(device_instances, sdi);
+	dev_insts = g_slist_append(dev_insts, sdi);
 
 	return 1;
-free_alsa:
-	free(alsa);
+
+free_ctx:
+	g_free(ctx);
 	return 0;
 }
 
-static int hw_opendev(int device_index)
+static int hw_dev_open(int dev_index)
 {
-	struct sigrok_device_instance *sdi;
-	struct alsa *alsa;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
 	int err;
 
-	if (!(sdi = get_sigrok_device_instance(device_instances, 0)))
-		return SIGROK_ERR;
-	alsa = sdi->priv;
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
 
-	err = snd_pcm_open(&alsa->capture_handle, AUDIO_DEV,
-					SND_PCM_STREAM_CAPTURE, 0);
+	err = snd_pcm_open(&ctx->capture_handle, AUDIO_DEV,
+			   SND_PCM_STREAM_CAPTURE, 0);
 	if (err < 0) {
-		g_warning("cannot open audio device %s (%s)", AUDIO_DEV,
-				snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't open audio device %s (%s)", AUDIO_DEV,
+		       snd_strerror(err));
+		return SR_ERR;
 	}
 
-	err = snd_pcm_hw_params_malloc(&alsa->hw_params);
+	err = snd_pcm_hw_params_malloc(&ctx->hw_params);
 	if (err < 0) {
-		g_warning("cannot allocate hardware parameter structure (%s)",
-				snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't allocate hardware parameter structure (%s)",
+		       snd_strerror(err));
+		return SR_ERR;
 	}
 
-	err = snd_pcm_hw_params_any(alsa->capture_handle, alsa->hw_params);
+	err = snd_pcm_hw_params_any(ctx->capture_handle, ctx->hw_params);
 	if (err < 0) {
-		g_warning("cannot initialize hardware parameter structure (%s)",
-				snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't initialize hardware parameter structure "
+		       "(%s)", snd_strerror(err));
+		return SR_ERR;
 	}
 
-	return SIGROK_OK;
+	return SR_OK;
 }
 
-static void hw_closedev(int device_index)
+static int hw_dev_close(int dev_index)
 {
-	struct sigrok_device_instance *sdi;
-	struct alsa *alsa;
-
-	if (!(sdi = get_sigrok_device_instance(device_instances, 0)))
-		return;
-	alsa = sdi->priv;
-	if (!alsa)
-		return;
-
-	if (alsa->hw_params)
-		snd_pcm_hw_params_free(alsa->hw_params);
-	if (alsa->capture_handle)
-		snd_pcm_close(alsa->capture_handle);
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
+		sr_err("alsa: %s: sdi was NULL", __func__);
+		return SR_ERR; /* TODO: SR_ERR_ARG? */
+	}
+
+	if (!(ctx = sdi->priv)) {
+		sr_err("alsa: %s: sdi->priv was NULL", __func__);
+		return SR_ERR; /* TODO: SR_ERR_ARG? */
+	}
+
+	// TODO: Return values of snd_*?
+	if (ctx->hw_params)
+		snd_pcm_hw_params_free(ctx->hw_params);
+	if (ctx->capture_handle)
+		snd_pcm_close(ctx->capture_handle);
+
+	return SR_OK;
 }
 
-static void hw_cleanup(void)
+static int hw_cleanup(void)
 {
-	struct sigrok_device_instance *sdi;
+	struct sr_dev_inst *sdi;
 
-	if (!(sdi = get_sigrok_device_instance(device_instances, 0)))
-		return;
+	if (!(sdi = sr_dev_inst_get(dev_insts, 0))) {
+		sr_err("alsa: %s: sdi was NULL", __func__);
+		return SR_ERR_BUG;
+	}
 
-	free(sdi->priv);
-	sigrok_device_instance_free(sdi);
+	sr_dev_inst_free(sdi);
+
+	return SR_OK;
 }
 
-static void *hw_get_device_info(int device_index, int device_info_id)
+static void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
-	struct sigrok_device_instance *sdi;
-	struct alsa *alsa;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
 	void *info = NULL;
 
-	if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
 		return NULL;
-	alsa = sdi->priv;
+	ctx = sdi->priv;
 
-	switch (device_info_id) {
-	case DI_INSTANCE:
+	switch (dev_info_id) {
+	case SR_DI_INST:
 		info = sdi;
 		break;
-	case DI_NUM_PROBES:
+	case SR_DI_NUM_PROBES:
 		info = GINT_TO_POINTER(NUM_PROBES);
 		break;
-	case DI_CUR_SAMPLERATE:
-		info = &alsa->cur_rate;
+	case SR_DI_PROBE_NAMES:
+		info = probe_names;
 		break;
-	case DI_PROBE_TYPE:
-		info = GINT_TO_POINTER(PROBE_TYPE_ANALOG);
+	case SR_DI_CUR_SAMPLERATE:
+		info = &ctx->cur_rate;
 		break;
+	// case SR_DI_PROBE_TYPE:
+	// 	info = GINT_TO_POINTER(SR_PROBE_TYPE_ANALOG);
+	// 	break;
 	}
 
 	return info;
 }
 
-static int hw_get_status(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
 	/* Avoid compiler warnings. */
-	device_index = device_index;
+	dev_index = dev_index;
 
-	return ST_ACTIVE;
+	return SR_ST_ACTIVE;
 }
 
-static int *hw_get_capabilities(void)
+static int *hw_hwcap_get_all(void)
 {
-	return capabilities;
+	return hwcaps;
 }
 
-static int hw_set_configuration(int device_index, int capability, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 {
-	struct sigrok_device_instance *sdi;
-	struct alsa *alsa;
-
-	if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
-		return SIGROK_ERR;
-	alsa = sdi->priv;
-
-	switch (capability) {
-	case HWCAP_PROBECONFIG:
-		return SIGROK_OK;
-	case HWCAP_SAMPLERATE:
-		alsa->cur_rate = *(uint64_t *) value;
-		return SIGROK_OK;
-	case HWCAP_LIMIT_SAMPLES:
-		alsa->limit_samples = *(uint64_t *) value;
-		return SIGROK_OK;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
+
+	switch (hwcap) {
+	case SR_HWCAP_PROBECONFIG:
+		return SR_OK;
+	case SR_HWCAP_SAMPLERATE:
+		ctx->cur_rate = *(uint64_t *)value;
+		return SR_OK;
+	case SR_HWCAP_LIMIT_SAMPLES:
+		ctx->limit_samples = *(uint64_t *)value;
+		return SR_OK;
 	default:
-		return SIGROK_ERR;
+		return SR_ERR;
 	}
 }
 
 static int receive_data(int fd, int revents, void *user_data)
 {
-	struct sigrok_device_instance *sdi = user_data;
-	struct alsa *alsa = sdi->priv;
-	struct datafeed_packet packet;
-	struct analog_sample *sample;
-	unsigned int sample_size = sizeof(struct analog_sample) +
-		(NUM_PROBES * sizeof(struct analog_probe));
+	struct sr_dev_inst *sdi = user_data;
+	struct context *ctx = sdi->priv;
+	struct sr_datafeed_packet packet;
+	struct sr_analog_sample *sample;
+	unsigned int sample_size = sizeof(struct sr_analog_sample) +
+		(NUM_PROBES * sizeof(struct sr_analog_probe));
 	char *outb;
 	char inb[4096];
 	int i, x, count;
 
+	fd = fd;
+	revents = revents;
+
 	do {
 		memset(inb, 0, sizeof(inb));
-		count = snd_pcm_readi(alsa->capture_handle, inb,
-			MIN(4096/4, alsa->limit_samples));
+		count = snd_pcm_readi(ctx->capture_handle, inb,
+			MIN(4096 / 4, ctx->limit_samples));
 		if (count < 1) {
-			g_warning("Failed to read samples");
+			sr_err("alsa: Failed to read samples");
 			return FALSE;
 		}
 
-		outb = malloc(sample_size * count);
-		if (!outb)
+		if (!(outb = g_try_malloc(sample_size * count))) {
+			sr_err("alsa: %s: outb malloc failed", __func__);
 			return FALSE;
+		}
 
 		for (i = 0; i < count; i++) {
-			sample = (struct analog_sample *)
+			sample = (struct sr_analog_sample *)
 						(outb + (i * sample_size));
 			sample->num_probes = NUM_PROBES;
 
 			for (x = 0; x < NUM_PROBES; x++) {
 				sample->probes[x].val =
-					*(uint16_t *) (inb + (i * 4) + (x * 2));
+					*(uint16_t *)(inb + (i * 4) + (x * 2));
 				sample->probes[x].val &= ((1 << 16) - 1);
 				sample->probes[x].res = 16;
 			}
 		}
 
-		packet.type = DF_ANALOG;
+		packet.type = SR_DF_ANALOG;
 		packet.length = count * sample_size;
 		packet.unitsize = sample_size;
 		packet.payload = outb;
-		session_bus(user_data, &packet);
-		free(outb);
-		alsa->limit_samples -= count;
+		sr_session_bus(user_data, &packet);
+		g_free(outb);
+		ctx->limit_samples -= count;
 
-	} while (alsa->limit_samples > 0);
+	} while (ctx->limit_samples > 0);
 
-	packet.type = DF_END;
-	session_bus(user_data, &packet);
+	packet.type = SR_DF_END;
+	sr_session_bus(user_data, &packet);
 
 	return TRUE;
 }
 
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static int hw_dev_acquisition_start(int dev_index, gpointer session_dev_id)
 {
-	struct sigrok_device_instance *sdi;
-	struct alsa *alsa;
-	struct datafeed_packet packet;
-	struct datafeed_header header;
+	struct sr_dev_inst *sdi;
+	struct context *ctx;
+	struct sr_datafeed_packet packet;
+	struct sr_datafeed_header header;
 	struct pollfd *ufds;
 	int count;
 	int err;
 
-	if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
-		return SIGROK_ERR;
-	alsa = sdi->priv;
+	if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+		return SR_ERR;
+	ctx = sdi->priv;
 
-	err = snd_pcm_hw_params_set_access(alsa->capture_handle,
-			alsa->hw_params, SND_PCM_ACCESS_RW_INTERLEAVED);
+	err = snd_pcm_hw_params_set_access(ctx->capture_handle,
+			ctx->hw_params, SND_PCM_ACCESS_RW_INTERLEAVED);
 	if (err < 0) {
-		g_warning("cannot set access type (%s)", snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't set access type (%s)", snd_strerror(err));
+		return SR_ERR;
 	}
 
 	/* FIXME: Hardcoded for 16bits */
-	err = snd_pcm_hw_params_set_format(alsa->capture_handle,
-			alsa->hw_params, SND_PCM_FORMAT_S16_LE);
+	err = snd_pcm_hw_params_set_format(ctx->capture_handle,
+			ctx->hw_params, SND_PCM_FORMAT_S16_LE);
 	if (err < 0) {
-		g_warning("cannot set sample format (%s)", snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't set sample format (%s)", snd_strerror(err));
+		return SR_ERR;
 	}
 
-	err = snd_pcm_hw_params_set_rate_near(alsa->capture_handle,
-			alsa->hw_params, (unsigned int *) &alsa->cur_rate, 0);
+	err = snd_pcm_hw_params_set_rate_near(ctx->capture_handle,
+			ctx->hw_params, (unsigned int *)&ctx->cur_rate, 0);
 	if (err < 0) {
-		g_warning("cannot set sample rate (%s)", snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't set sample rate (%s)", snd_strerror(err));
+		return SR_ERR;
 	}
 
-	err = snd_pcm_hw_params_set_channels(alsa->capture_handle,
-			alsa->hw_params, NUM_PROBES);
+	err = snd_pcm_hw_params_set_channels(ctx->capture_handle,
+			ctx->hw_params, NUM_PROBES);
 	if (err < 0) {
-		g_warning("cannot set channel count (%s)", snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't set channel count (%s)", snd_strerror(err));
+		return SR_ERR;
 	}
 
-	err = snd_pcm_hw_params(alsa->capture_handle, alsa->hw_params);
+	err = snd_pcm_hw_params(ctx->capture_handle, ctx->hw_params);
 	if (err < 0) {
-		g_warning("cannot set parameters (%s)", snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't set parameters (%s)", snd_strerror(err));
+		return SR_ERR;
 	}
 
-	err = snd_pcm_prepare(alsa->capture_handle);
+	err = snd_pcm_prepare(ctx->capture_handle);
 	if (err < 0) {
-		g_warning("cannot prepare audio interface for use (%s)",
-				snd_strerror(err));
-		return SIGROK_ERR;
+		sr_err("alsa: can't prepare audio interface for use (%s)",
+		       snd_strerror(err));
+		return SR_ERR;
 	}
 
-	count = snd_pcm_poll_descriptors_count(alsa->capture_handle);
+	count = snd_pcm_poll_descriptors_count(ctx->capture_handle);
 	if (count < 1) {
-		g_warning("Unable to obtain poll descriptors count");
-		return SIGROK_ERR;
+		sr_err("alsa: Unable to obtain poll descriptors count");
+		return SR_ERR;
 	}
 
-	ufds = malloc(count * sizeof(struct pollfd));
-	if (!ufds)
-		return SIGROK_ERR_MALLOC;
+	if (!(ufds = g_try_malloc(count * sizeof(struct pollfd)))) {
+		sr_err("alsa: %s: ufds malloc failed", __func__);
+		return SR_ERR_MALLOC;
+	}
 
-	err = snd_pcm_poll_descriptors(alsa->capture_handle, ufds, count);
+	err = snd_pcm_poll_descriptors(ctx->capture_handle, ufds, count);
 	if (err < 0) {
-		g_warning("Unable to obtain poll descriptors (%s)",
-				snd_strerror(err));
-		free(ufds);
-		return SIGROK_ERR;
+		sr_err("alsa: Unable to obtain poll descriptors (%s)",
+		       snd_strerror(err));
+		g_free(ufds);
+		return SR_ERR;
 	}
 
-	alsa->session_id = session_device_id;
-	source_add(ufds[0].fd, ufds[0].events, 10, receive_data, sdi);
+	ctx->session_id = session_dev_id;
+	sr_source_add(ufds[0].fd, ufds[0].events, 10, receive_data, sdi);
 
-	packet.type = DF_HEADER;
-	packet.length = sizeof(struct datafeed_header);
-	packet.payload = (unsigned char *) &header;
+	packet.type = SR_DF_HEADER;
+	packet.length = sizeof(struct sr_datafeed_header);
+	packet.payload = (unsigned char *)&header;
 	header.feed_version = 1;
 	gettimeofday(&header.starttime, NULL);
-	header.samplerate = alsa->cur_rate;
+	header.samplerate = ctx->cur_rate;
 	header.num_analog_probes = NUM_PROBES;
 	header.num_logic_probes = 0;
-	header.protocol_id = PROTO_RAW;
-	session_bus(session_device_id, &packet);
-	free(ufds);
+	header.protocol_id = SR_PROTO_RAW;
+	sr_session_bus(session_dev_id, &packet);
+	g_free(ufds);
 
-	return SIGROK_OK;
+	return SR_OK;
 }
 
-static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+static int hw_dev_acquisition_stop(int dev_index, gpointer session_dev_id)
 {
 	/* Avoid compiler warnings. */
-	device_index = device_index;
-	session_device_id = session_device_id;
+	dev_index = dev_index;
+	session_dev_id = session_dev_id;
+
+	return SR_OK;
 }
 
-struct device_plugin alsa_plugin_info = {
-	"alsa",
-	1,
-	hw_init,
-	hw_cleanup,
-	hw_opendev,
-	hw_closedev,
-	hw_get_device_info,
-	hw_get_status,
-	hw_get_capabilities,
-	hw_set_configuration,
-	hw_start_acquisition,
-	hw_stop_acquisition,
+SR_PRIV struct sr_dev_plugin alsa_plugin_info = {
+	.name = "alsa",
+	.longname = "ALSA driver",
+	.api_version = 1,
+	.init = hw_init,
+	.cleanup = hw_cleanup,
+	.dev_open = hw_dev_open,
+	.dev_close = hw_dev_close,
+	.dev_info_get = hw_dev_info_get,
+	.dev_status_get = hw_dev_status_get,
+	.hwcap_get_all = hw_hwcap_get_all,
+	.dev_config_set = hw_dev_config_set,
+	.dev_acquisition_start = hw_dev_acquisition_start,
+	.dev_acquisition_stop = hw_dev_acquisition_stop,
 };