^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (C) 2016 Robert Jarzmik <robert.jarzmik@free.fr>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) #ifndef __SOUND_AC97_CODEC2_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #define __SOUND_AC97_CODEC2_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #define AC97_ID(vendor_id1, vendor_id2) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) ((((vendor_id1) & 0xffff) << 16) | ((vendor_id2) & 0xffff))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #define AC97_DRIVER_ID(vendor_id1, vendor_id2, mask_id1, mask_id2, _data) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) { .id = (((vendor_id1) & 0xffff) << 16) | ((vendor_id2) & 0xffff), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) .mask = (((mask_id1) & 0xffff) << 16) | ((mask_id2) & 0xffff), \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) .data = (_data) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) struct ac97_controller;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) struct clk;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) * struct ac97_id - matches a codec device and driver on an ac97 bus
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) * @id: The significant bits if the codec vendor ID1 and ID2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * @mask: Bitmask specifying which bits of the id field are significant when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * matching. A driver binds to a device when :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * ((vendorID1 << 8 | vendorID2) & (mask_id1 << 8 | mask_id2)) == id.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) * @data: Private data used by the driver.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) struct ac97_id {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) unsigned int id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) unsigned int mask;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) void *data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * ac97_codec_device - a ac97 codec
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) * @dev: the core device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) * @vendor_id: the vendor_id of the codec, as sensed on the AC-link
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) * @num: the codec number, 0 is primary, 1 is first slave, etc ...
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * @clk: the clock BIT_CLK provided by the codec
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * @ac97_ctrl: ac97 digital controller on the same AC-link
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * This is the device instantiated for each codec living on a AC-link. There are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * normally 0 to 4 codec devices per AC-link, and all of them are controlled by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) * an AC97 digital controller.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) struct ac97_codec_device {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) struct device dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) unsigned int vendor_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) unsigned int num;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) struct clk *clk;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) struct ac97_controller *ac97_ctrl;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * ac97_codec_driver - a ac97 codec driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * @driver: the device driver structure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) * @probe: the function called when a ac97_codec_device is matched
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) * @remove: the function called when the device is unbound/removed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * @shutdown: shutdown function (might be NULL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) * @id_table: ac97 vendor_id match table, { } member terminated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) struct ac97_codec_driver {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) struct device_driver driver;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) int (*probe)(struct ac97_codec_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) int (*remove)(struct ac97_codec_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) void (*shutdown)(struct ac97_codec_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) const struct ac97_id *id_table;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) static inline struct ac97_codec_device *to_ac97_device(struct device *d)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) return container_of(d, struct ac97_codec_device, dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) static inline struct ac97_codec_driver *to_ac97_driver(struct device_driver *d)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) return container_of(d, struct ac97_codec_driver, driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) #if IS_ENABLED(CONFIG_AC97_BUS_NEW)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) int snd_ac97_codec_driver_register(struct ac97_codec_driver *drv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) void snd_ac97_codec_driver_unregister(struct ac97_codec_driver *drv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) static inline int
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) snd_ac97_codec_driver_register(struct ac97_codec_driver *drv)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) static inline void
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) snd_ac97_codec_driver_unregister(struct ac97_codec_driver *drv)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) static inline struct device *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) ac97_codec_dev2dev(struct ac97_codec_device *adev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) return &adev->dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) static inline void *ac97_get_drvdata(struct ac97_codec_device *adev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) return dev_get_drvdata(ac97_codec_dev2dev(adev));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) static inline void ac97_set_drvdata(struct ac97_codec_device *adev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) void *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) dev_set_drvdata(ac97_codec_dev2dev(adev), data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) void *snd_ac97_codec_get_platdata(const struct ac97_codec_device *adev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #endif