Linux内核4.14版本——alsa框架分析(18)——DAPM(9)——精髓所在，牵一发而动全身
目录
1. 统计widget连接至端点widget的路径个数
2. dapm_dirty链表
3. power_check回调函数
4. widget的上电和下电顺序
5. widget的上下电过程
5.1 dapm_power_widgets
5.2 dapm_power_one_widget
5.3 dapm_seq_run
5.4 dapm kcontrol的put回调
设计dapm的主要目的之一，就是希望声卡上的各种部件的电源按需分配，需要的就上电，不需要的就下电，使得整个音频系统总是处于最小的耗电状态，最主要的就是，这一切对用户空间的应用程序是透明的，也就是说，用户空间的应用程序无需关心那个部件何时需要电源，它只要按需要设定好音频路径，播放音频数据，暂停或停止，dapm框架会根据音频路径，完美地对各种部件的电源进行控制，而且精确地按某种顺序进行，防止上下电过程中产生不必要的pop-pop声。这就是本章我们需要讨论的内容。
1. 统计widget连接至端点widget的路径个数
在《注册widget、route、path》这篇文章中的最后一节，我们曾经提出了端点widget这一概念，端点widget位于音频路径的起始端或者末端，所以通常它们就是指codec的输入输出引脚所对应的widget，或者是外部器件对应的widget，这些widget的类型有以下这些：
dapm要给一个widget上电的其中一个前提条件是：这个widget位于一条完整的音频路径上，而一条完整的音频路径的两头，必须是输入/输出引脚，或者是一个外部音频设备，又或者是一个处于激活状态的音频流widget，也就是上表中的前三项，上表中的后两项，它们可以位于路径的末端，但不是构成完成音频路径的必要条件，我们只用它来判断扫描一条路径的结束条件。dapm提供了两个内部函数，用来统计一个widget连接到输出引脚、输入引脚、激活的音频流widget的有效路径个数：
is_connected_output_ep 返回连接至输出引脚或激活状态的输出音频流的路径数量
is_connected_input_ep 返回连接至输入引脚或激活状态的输入音频流的路径数量
下面我贴出is_connected_output_ep函数和必要的注释：
/*
* Recursively check for a completed path to an active or physically connected
* output widget. Returns number of complete paths.
*
* Optionally, can be supplied with a function acting as a stopping condition.
* This function takes the dapm widget currently being examined and the walk
* direction as an arguments, it should return true if widgets from that point
* in the graph onwards should not be added to the widget list.
*/
static int is_connected_output_ep(struct snd_soc_dapm_widget *widget,
struct list_head *list,
bool (*custom_stop_condition)(struct snd_soc_dapm_widget *i,
enum snd_soc_dapm_direction))
{
return is_connected_ep(widget, list, SND_SOC_DAPM_DIR_OUT,
is_connected_output_ep, custom_stop_condition);
}static int is_connected_output_ep(struct snd_soc_dapm_widget *widget,
struct snd_soc_dapm_widget_list **list)
{
struct snd_soc_dapm_path *path;
int con = 0;
/* 多个路径可能使用了同一个widget，如果在遍历另一个路径时，*/
/* 已经统计过该widget，直接返回output字段即可。 */
if (widget->outputs >= 0)
return widget->outputs;
/* 以下这几种widget是端点widget，但不是输出，所以直接返回0，结束该路径的扫描 */
switch (widget->id) {
case snd_soc_dapm_supply:
case snd_soc_dapm_regulator_supply:
case snd_soc_dapm_clock_supply:
case snd_soc_dapm_kcontrol:
return 0;
default:
break;
}
/* 对于音频流widget，如果处于激活状态，如果没有休眠，返回1，否则，返回0 */
/* 而且对于激活的音频流widget是端点widget，所以也会结束该路径的扫描 */
/* 如果没有处于激活状态，按普通的widget继续往下执行 */
switch (widget->id) {
case snd_soc_dapm_adc:
case snd_soc_dapm_aif_out:
case snd_soc_dapm_dai_out:
if (widget->active) {
widget->outputs = snd_soc_dapm_suspend_check(widget);
return widget->outputs;
}
default:
break;
}
if (widget->connected) {
/* 处于连接状态的输出引脚，也根据休眠状态返回1或0 */
if (widget->id == snd_soc_dapm_output && !widget->ext) {
widget->outputs = snd_soc_dapm_suspend_check(widget);
return widget->outputs;
}
/* 处于连接状态的输出设备，也根据休眠状态返回1或0 */
if (widget->id == snd_soc_dapm_hp ||
widget->id == snd_soc_dapm_spk ||
(widget->id == snd_soc_dapm_line &&
!list_empty(&widget->sources))) {
widget->outputs = snd_soc_dapm_suspend_check(widget);
return widget->outputs;
}
}
/* 不是端点widget，循环查询它的输出端 */
list_for_each_entry(path, &widget->sinks, list_source) {
DAPM_UPDATE_STAT(widget, neighbour_checks);
if (path->weak)
continue;
if (path->walking) /* 比较奇怪，防止无限循环的路径？ */
return 1;
if (path->walked)
continue;
if (path->sink && path->connect) {
path->walked = 1;
path->walking = 1;
......
/* 递归调用，统计每一个输出端 */
con += is_connected_output_ep(path->sink, list);
path->walking = 0;
}
}
widget->outputs = con;
return con;
}该函数使用了递归算法，直到遇到端点widget为止才停止扫描，把统计到的输出路径个数保存在output字段中并返回。is_connected_intput_ep函数的原理差不多，有兴趣的可以自己查看内核的原码。
2. dapm_dirty链表
在代表声卡的snd_soc_card结构中，有一个链表字段：dapm_dirty，所有状态发生了改变的widget，dapm不会立刻处理它的电源状态，而是需要先挂在该链表下面，等待后续的进一步处理：或者是上电，或者是下电。dapm为我们提供了一个api函数来完成这个动作：
void dapm_mark_dirty(struct snd_soc_dapm_widget *w, const char *reason)
{
if (!dapm_dirty_widget(w)) {
dev_vdbg(w->dapm->dev, "Marking %s dirty due to %s\n",
w->name, reason);
list_add_tail(&w->dirty, &w->dapm->card->dapm_dirty);
}
}3. power_check回调函数
在文章《建立widget之间的连接关系》中，我们知道，在创建widget的时候，widget的power_check回调函数会根据widget的类型，设置不同的回调函数。当widget的状态改变后，dapm会遍历dapm_dirty链表，并通过power_check回调函数，决定该widget是否需要上电。大多数的widget的power_check回调被设置为：dapm_generic_check_power：
/* Generic check to see if a widget should be powered. */
static int dapm_generic_check_power(struct snd_soc_dapm_widget *w)
{
int in, out;
DAPM_UPDATE_STAT(w, power_checks);
in = is_connected_input_ep(w, NULL, NULL);
out = is_connected_output_ep(w, NULL, NULL);
return out != 0 && in != 0;
} 很简单，分别用is_connected_output_ep和is_connected_input_ep得到该widget是否有同时连接到一个输入端和一个输出端，如果是，返回1来表示该widget需要上电。
处于激活状态时，只判断是否有连接到有效的输出路径即可，没有激活时，则需要同时判断是否有连接到输入路径和输出路径。
4. widget的上电和下电顺序
在扫描d保存需要上apm_dirty链表时，dapm使用两个链表来分别电和需要下电的widget：
up_list 保存需要上电的widget
down_list 保存需要下电的widget
dapm内部使用dapm_seq_insert函数把一个widget加入到上述两个链表中的其中一个：
static void dapm_seq_insert(struct snd_soc_dapm_widget *new_widget,
struct list_head *list,
bool power_up)
{
struct snd_soc_dapm_widget *w;
list_for_each_entry(w, list, power_list)
if (dapm_seq_compare(new_widget, w, power_up) < 0) {
list_add_tail(&new_widget->power_list, &w->power_list);
return;
}
list_add_tail(&new_widget->power_list, list);
}上述函数会按照一定的顺序把widget加入到链表中，从而保证正确的上下电顺序：
/* dapm power sequences - make this per codec in the future */
static int dapm_up_seq[] = {
[snd_soc_dapm_pre] = 0,
[snd_soc_dapm_regulator_supply] = 1,
[snd_soc_dapm_clock_supply] = 1,
[snd_soc_dapm_supply] = 2,
[snd_soc_dapm_micbias] = 3,
[snd_soc_dapm_vmid] = 3,
[snd_soc_dapm_dai_link] = 2,
[snd_soc_dapm_dai_in] = 4,
[snd_soc_dapm_dai_out] = 4,
[snd_soc_dapm_aif_in] = 4,
[snd_soc_dapm_aif_out] = 4,
[snd_soc_dapm_mic] = 5,
[snd_soc_dapm_siggen] = 5,
[snd_soc_dapm_input] = 5,
[snd_soc_dapm_output] = 5,
[snd_soc_dapm_mux] = 6,
[snd_soc_dapm_demux] = 6,
[snd_soc_dapm_dac] = 7,
[snd_soc_dapm_switch] = 8,
[snd_soc_dapm_mixer] = 8,
[snd_soc_dapm_mixer_named_ctl] = 8,
[snd_soc_dapm_pga] = 9,
[snd_soc_dapm_buffer] = 9,
[snd_soc_dapm_scheduler] = 9,
[snd_soc_dapm_effect] = 9,
[snd_soc_dapm_src] = 9,
[snd_soc_dapm_asrc] = 9,
[snd_soc_dapm_encoder] = 9,
[snd_soc_dapm_decoder] = 9,
[snd_soc_dapm_adc] = 10,
[snd_soc_dapm_out_drv] = 11,
[snd_soc_dapm_hp] = 11,
[snd_soc_dapm_spk] = 11,
[snd_soc_dapm_line] = 11,
[snd_soc_dapm_sink] = 11,
[snd_soc_dapm_kcontrol] = 12,
[snd_soc_dapm_post] = 13,
};static int dapm_down_seq[] = {
[snd_soc_dapm_pre] = 0,
[snd_soc_dapm_kcontrol] = 1,
[snd_soc_dapm_adc] = 2,
[snd_soc_dapm_hp] = 3,
[snd_soc_dapm_spk] = 3,
[snd_soc_dapm_line] = 3,
[snd_soc_dapm_out_drv] = 3,
[snd_soc_dapm_sink] = 3,
[snd_soc_dapm_pga] = 4,
[snd_soc_dapm_buffer] = 4,
[snd_soc_dapm_scheduler] = 4,
[snd_soc_dapm_effect] = 4,
[snd_soc_dapm_src] = 4,
[snd_soc_dapm_asrc] = 4,
[snd_soc_dapm_encoder] = 4,
[snd_soc_dapm_decoder] = 4,
[snd_soc_dapm_switch] = 5,
[snd_soc_dapm_mixer_named_ctl] = 5,
[snd_soc_dapm_mixer] = 5,
[snd_soc_dapm_dac] = 6,
[snd_soc_dapm_mic] = 7,
[snd_soc_dapm_siggen] = 7,
[snd_soc_dapm_input] = 7,
[snd_soc_dapm_output] = 7,
[snd_soc_dapm_micbias] = 8,
[snd_soc_dapm_vmid] = 8,
[snd_soc_dapm_mux] = 9,
[snd_soc_dapm_demux] = 9,
[snd_soc_dapm_aif_in] = 10,
[snd_soc_dapm_aif_out] = 10,
[snd_soc_dapm_dai_in] = 10,
[snd_soc_dapm_dai_out] = 10,
[snd_soc_dapm_dai_link] = 11,
[snd_soc_dapm_supply] = 12,
[snd_soc_dapm_clock_supply] = 13,
[snd_soc_dapm_regulator_supply] = 13,
[snd_soc_dapm_post] = 14,
};5. widget的上下电过程
5.1 dapm_power_widgets
当一个widget的状态改变后，该widget会被加入dapm_dirty链表，然后通过dapm_power_widgets函数来改变整个音频路径上的电源状态，下图展现了这个函数的调用过程：
图1 widget的上电过程
可见，该函数通过遍历dapm_dirty链表，对每个链表中的widget调用dapm_power_one_widget，dapm_power_one_widget函数除了处理自身的状态改变外，还把自身的变化传递到和它相连的邻居widget中，结果就是，所有需要上电的widget会被放在up_list链表中，而所有需要下电的widget会被放在down_list链表中，这个函数我们稍后再讨论。
遍历down_list链表，向其中的widget发出SND_SOC_DAPM_WILL_PMD事件，感兴趣该事件的widget的event回调会被调用。
遍历up_list链表，向其中的widget发出SND_SOC_DAPM_WILL_PMU事件，感兴趣该事件的widget的event回调会被调用。
通过dapm_seq_run函数，处理down_list中的widget，使它们按定义好的顺序依次下电。
通过dapm_widget_update函数，切换触发该次状态变化的widget的kcontrol中的寄存器值，对应的结果就是：改变音频路径。
通过dapm_seq_run函数，处理up_list中的widget，使它们按定义好的顺序依次上电。
对每个dapm context发出状态改变回调。
适当的延时，防止pop-pop声。
5.2 dapm_power_one_widget
dapm_power_widgets的第一步，就是遍历dapm_dirty链表，对每个链表中的widget调用dapm_power_one_widget，把需要上电和需要下电的widget分别加入到up_list和down_list链表中，同时，他还会把受到影响的邻居widget再次加入到dapm_dirty链表的末尾，通过这个动作，声卡中所以受到影响的widget都会被“感染”，依次被加到dapm_dirty链表，然后依次被执行dapm_power_one_widget函数。下图展示了dapm_power_one_widget函数的调用序列：
图二 dapm_power_one_widget函数调用过程
通过dapm_widget_power_check，调用widget的power_check回调函数，获得该widget新的电源状态。
调用dapm_widget_set_power，“感染”与之相连的邻居widget。
遍历source widget，通过dapm_widget_set_peer_power函数，把处于连接状态的source widget加入dapm_dirty链表中。
遍历sink widget，通过dapm_widget_set_peer_power函数，把处于连接状态的sink widget加入dapm_dirty链表中。
根据第一步得到的新的电源状态，把widget加入到up_list或down_list链表中。
可见，通过该函数，一个widget的状态改变，邻居widget会受到“感染”而被加入到dapm_dirty链表的末尾，所以扫描到链表的末尾时，邻居widget也会执行同样的操作，从而“感染”邻居的邻居，直到没有新的widget被加入dapm_dirty链表为止，这时，所有受到影响的widget都被加入到up_list或down_li链表中，等待后续的上下电操作。这就是文章的标题所说的那样： 牵一发而动全身。
5.3 dapm_seq_run
参看图一的上电过程，当所有需要上电或下电的widget都被加入到dapm_dirty链表后，接着会通过dapm_seq_run处理down_list链表上的widget，把该链表上的widget按顺序下电，然后通过dapm_widget_update更新widget中的kcontrol（这个kcontrol通常就是触发本次状态改变的触发源），接着又通过apm_seq_run处理up_list链表上的widget，把该链表上的widget按顺序上电。最终的上电或下电操作需要通过codec的寄存器来实现，因为定义widget时，如果这是一个带电源控制的widget，我们必须提供reg/shift等字段的设置值，如果该widget无需寄存器控制电源状态，则reg字段必须赋值为：
SND_SOC_NOPM (该宏定义的实际值是-1)
具体实现上，dapm框架使用了一点技巧：如果位于同一个上下电顺序的几个widget使用了同一个寄存器地址（一个寄存器可能使用不同的位来控制不同的widget的电源状态），dapm_seq_run通过dapm_seq_run_coalesced函数合并这几个widget的变更，然后只需要把合并后的值一次写入寄存器即可。
5.4 dapm kcontrol的put回调
上面我们已经讨论了如何判断一个widget是否需要上电，以及widget的上电过程，一个widget的状态改变如何传递到整个音频路径上的所有widget。这些过程总是需要一个起始点：是谁触动了dapm，使得它需要执行上述的扫描和上电过程？事实上，以下几种情况可以触发dapm发起一次扫描操作：
声卡初始化阶段，snd_soc_dapm_new_widgets函数创建widget包含的kcontrol后，会触发一次扫描操作。
用户空间的应用程序修改了widget中包含的dapm kcontrol的配置值时，会触发一次扫描操作。
pcm的打开或关闭，会通过音频流widget触发一次扫描操作。
驱动程序在改变了某个widget并把它加入到dapm_dirty链表后，主动调用snd_soc_dapm_sync函数触发扫描操作。
这里我们主要讨论一下第二种，用户空间对kcontrol的修改，最终都会调用到kcontrol的put回调函数。对于常用的dapm kcontrol，系统已经为我们定义好了它们的put回调函数：
snd_soc_dapm_put_volsw mixer类型的dapm kcontrol使用的put回调
snd_soc_dapm_put_enum_double mux类型的dapm kcontrol使用的put回调
snd_soc_dapm_put_enum_virt 虚拟mux类型的dapm kcontrol使用的put回调
snd_soc_dapm_put_value_enum_double 控制值不连续的mux类型的dapm kcontrol使用的put回调
snd_soc_dapm_put_pin_switch 引脚类dapm kcontrol使用的put回调
我们以mixer类型的dapm kcontrol的put回调讲解一下触发的过程：
图三 mixer dapm kcontrol的put回调
int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
struct snd_ctl_elem_value *ucontrol)
{
struct snd_soc_codec *codec = snd_soc_dapm_kcontrol_codec(kcontrol);
struct snd_soc_card *card = codec->card;
struct soc_mixer_control *mc =
(struct soc_mixer_control *)kcontrol->private_value;
unsigned int reg = mc->reg;
unsigned int shift = mc->shift;
int max = mc->max;
unsigned int mask = (1 << fls(max)) - 1;
unsigned int invert = mc->invert;
unsigned int val;
int connect, change;
struct snd_soc_dapm_update update;
......
/* 从参数中取出要设置的新的设置值 */
val = (ucontrol->value.integer.value[0] & mask);
connect = !!val;
if (invert)
val = max - val;
/* 把新的设置值缓存到kcontrol的影子widget中 */
dapm_kcontrol_set_value(kcontrol, val);
mask = mask << shift;
val = val << shift;
/* 和实际寄存器中的值进行对比，不一样时才会触发寄存器的写入 */
/* 寄存器通常都会通过regmap机制进行缓存，所以这个测试不会发生实际的寄存器读取操作 */
/* 这里只是触发，真正的寄存器写入操作要在扫描完dapm_dirty链表后的执行 */
change = snd_soc_test_bits(codec, reg, mask, val);
if (change) {
update.kcontrol = kcontrol;
update.reg = reg;
update.mask = mask;
update.val = val;
card->update = &update;
/* 触发dapm的上下电扫描过程 */
soc_dapm_mixer_update_power(card, kcontrol, connect);
card->update = NULL;
}
......
return change;
} 其中的dapm_kcontrol_set_value函数用于把设置值缓存到kcontrol对应的影子widget，影子widget是为了实现autodisable特性而创建的一个虚拟widget，影子widget的输出连接到kcontrol的source widget，影子widget的寄存器被设置为和kcontrol一样的寄存器地址，这样当source widget被关闭时，会触发影子widget被关闭，其作用就是kcontrol也被自动关闭从而在物理上断开与source widget的连接，但是此时逻辑连接依然有效，dapm依然认为它们是连接在一起的。
触发dapm进行电源状态扫描关键的函数是soc_dapm_mixer_update_power：
static int soc_dapm_mixer_update_power(struct snd_soc_card *card,
struct snd_kcontrol *kcontrol, int connect)
{
struct snd_soc_dapm_path *path;
int found = 0;
/* 更新所有和该kcontrol对应输入端相连的path的connect字段 */
dapm_kcontrol_for_each_path(path, kcontrol) {
found = 1;
path->connect = connect;
/*把自己和相连的source widget加入到dirty链表中*/
dapm_mark_dirty(path->source, "mixer connection");
dapm_mark_dirty(path->sink, "mixer update");
}
/* 发起dapm_dirty链表扫描和上下电过程 */
if (found)
dapm_power_widgets(card, SND_SOC_DAPM_STREAM_NOP);
return found;
}最终，还是通过dapm_power_widgets函数，触发整个音频路径的扫描过程，这个函数执行后，因为kcontrol的状态改变，被断开连接的音频路径上的所有widget被按顺序下电，而重新连上的音频路径上的所有widget被顺序地上电，所以，尽管我们只改变了mixer kcontrol中的一个输入端的连接状态，所有相关的widget的电源状态都会被重新设定，这一切，都是自动完成的，对用户空间的应用程序完全透明，实现了dapm的原本设计目标。