include/sound/seq_device.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 #ifndef __SOUND_SEQ_DEVICE_H
0003 #define __SOUND_SEQ_DEVICE_H
0004
0005 /*
0006  *  ALSA sequencer device management
0007  *  Copyright (c) 1999 by Takashi Iwai <tiwai@suse.de>
0008  */
0009
0010 /*
0011  * registered device information
0012  */
0013
0014 struct snd_seq_device {
0015     /* device info */
0016     struct snd_card *card;  /* sound card */
0017     int device;     /* device number */
0018     const char *id;     /* driver id */
0019     char name[80];      /* device name */
0020     int argsize;        /* size of the argument */
0021     void *driver_data;  /* private data for driver */
0022     void *private_data; /* private data for the caller */
0023     void (*private_free)(struct snd_seq_device *device);
0024     struct device dev;
0025 };
0026
0027 #define to_seq_dev(_dev) \
0028     container_of(_dev, struct snd_seq_device, dev)
0029
0030 /* sequencer driver */
0031
0032 /* driver operators
0033  * probe:
0034  *  Initialize the device with given parameters.
0035  *  Typically,
0036  *      1. call snd_hwdep_new
0037  *      2. allocate private data and initialize it
0038  *      3. call snd_hwdep_register
0039  *      4. store the instance to dev->driver_data pointer.
0040  *
0041  * remove:
0042  *  Release the private data.
0043  *  Typically, call snd_device_free(dev->card, dev->driver_data)
0044  */
0045 struct snd_seq_driver {
0046     struct device_driver driver;
0047     char *id;
0048     int argsize;
0049 };
0050
0051 #define to_seq_drv(_drv) \
0052     container_of(_drv, struct snd_seq_driver, driver)
0053
0054 /*
0055  * prototypes
0056  */
0057 #ifdef CONFIG_MODULES
0058 void snd_seq_device_load_drivers(void);
0059 #else
0060 #define snd_seq_device_load_drivers()
0061 #endif
0062 int snd_seq_device_new(struct snd_card *card, int device, const char *id,
0063                int argsize, struct snd_seq_device **result);
0064
0065 #define SNDRV_SEQ_DEVICE_ARGPTR(dev) (void *)((char *)(dev) + sizeof(struct snd_seq_device))
0066
0067 int __must_check __snd_seq_driver_register(struct snd_seq_driver *drv,
0068                        struct module *mod);
0069 #define snd_seq_driver_register(drv) \
0070     __snd_seq_driver_register(drv, THIS_MODULE)
0071 void snd_seq_driver_unregister(struct snd_seq_driver *drv);
0072
0073 #define module_snd_seq_driver(drv) \
0074     module_driver(drv, snd_seq_driver_register, snd_seq_driver_unregister)
0075
0076 /*
0077  * id strings for generic devices
0078  */
0079 #define SNDRV_SEQ_DEV_ID_MIDISYNTH  "seq-midi"
0080 #define SNDRV_SEQ_DEV_ID_OPL3       "opl3-synth"
0081
0082 #endif /* __SOUND_SEQ_DEVICE_H */