コグノスケ

exim4 の設定

サーバの exim4 が IPv6 socket creation failed というエラーを出し続けていて、鬱陶しいです。

どうしたものかと思っていたら、同じ症状で悩んでいる人を見つけました。要は設定ファイルに disable_ipv6 = true を足せば良いだけみたいですが、Debian の exim4 は変な設定方法になっていて苦戦していました。

まずは、現在の状態を確認してみます。

# update-exim4.conf

# exim4 -bP disable_ipv6
no_disable_ipv6

これは無効（disable）が無効（no）なので、IPv6 有効状態です。なんで enable_ipv6 じゃないんだろう。変な名前…。

変更方法ですが、先ほどのフォーラムによれば /etc/exim4/update-exim4.conf.conf に足しても意味が無くて /etc/exim4/exim4.conf.template に足すと良いみたいです。

# vim /etc/exim4/exim4.conf.template

# update-exim4.conf

# exim4 -bP disable_ipv6
disable_ipv6

とりあえず設定ファイルの先頭に足してみたら効いているみたいですが、どこでも良いのか？これ。

一応 /usr/share/doc/exim4/README.Debian.gz にマニュアルがありますが、クッソ長くて読む気が起きないです。

拾い読みした感じだと、多分 2.1.1.12. Split configuration into small files の真ん中辺りに書いてある、

If you chose unsplit configuration, update-exim4.conf builds the configuration from /etc/exim4/exim4.conf.template, which is basically the files from /etc/exim4/conf.d/ concatenated together at package build time, and thus guarantees consistency on the target system.

設定ファイルを分割していない人（私がそう）は exim4.conf.template に全ての設定が書いてあるから、何か足したければ exim4.conf.template に足せば良さそうだな？ってのが何となくわかります。でも、仕組みは良いから使い方を書いてくれないかな…って気分になりますね。

ALSA のミキサーと regmap その 2

その 1、 その 2。

メモ代わりの超マニアックな話です。kcontrol については前回を参照。

ALSA の kcontrol はレジスタのアドレスと値の範囲を ALSA の共通レイヤに渡すだけで、ミキサー機能から、ハードウェアレジスタの値が書き換えられます。レジスタの値をアクセスする関数を一切書いていないにも関わらず、です。

最初、この仕組みがわからず、超不思議でした。どうなってるんでしょうか？

kcontrol と regmap

まず kcontrol が何をしているか見てみます。といっても kcontrol 側は深追いせず、レジスタアクセスのみ調べます。ちなみに kcontrol_new の何がどうなってミキサーに繋がるか調べるのは、かなり大変そうです……。

//linux-4.4/sound/soc/codecs/tas571x.c

static const struct snd_kcontrol_new tas5717_controls[] = {
...
        SOC_DOUBLE("Speaker Switch",
                   TAS571X_SOFT_MUTE_REG,
                   TAS571X_SOFT_MUTE_CH1_SHIFT, TAS571X_SOFT_MUTE_CH2_SHIFT,
                   1, 1),


//linux-4.4/include/sound/soc.h

#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
{       .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
        .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \    //★たぶんこれ使って読んでるんだろう★
        .put = snd_soc_put_volsw, \
        .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
                                          max, invert, 0) }


//linux-4.4/sound/soc/soc-ops.c

int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
        struct snd_ctl_elem_value *ucontrol)
{
...
        ret = snd_soc_read_signed(component, reg, mask, shift, sign_bit, &val);
        if (ret)
                return ret;
...


//linux-4.4/sound/soc/soc-ops.c

static int snd_soc_read_signed(struct snd_soc_component *component,
        unsigned int reg, unsigned int mask, unsigned int shift,
        unsigned int sign_bit, int *signed_val)
{
...
        ret = snd_soc_component_read(component, reg, &val);
        if (ret < 0)
                return ret;


//linux-4.4/sound/soc/soc-io.c

int snd_soc_component_read(struct snd_soc_component *component,
        unsigned int reg, unsigned int *val)
{
        int ret;

        if (component->regmap)
                ret = regmap_read(component->regmap, reg, val);    //★regmap で読み出すか★
        else if (component->read)
                ret = component->read(component, reg, val);    //★regmap が無くて、独自のレジスタアクセス関数があればそちらを使う★
        else
                ret = -EIO;    //★どちらもなければエラー★

        return ret;
}

はい、やっと出ました regmap です。コードを見ると component->regmap とやらを参照していますが、こんなものを設定した覚えはありません。どこから来たのでしょうか？

答えは前回の最後に呼んでいた snd_soc_register_codec() にあります。

snd_soc_register_codec

答えは snd_soc_register_codec() にある、あるんですけど、ちょっと面倒くさいです。

//linux-4.4/sound/soc/soc-core.c

int snd_soc_register_codec(struct device *dev,
                           const struct snd_soc_codec_driver *codec_drv,
                           struct snd_soc_dai_driver *dai_drv,
                           int num_dai)
{
...
        struct snd_soc_codec *codec;
...
        codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
        if (codec == NULL)
                return -ENOMEM;

        codec->component.codec = codec;

        ret = snd_soc_component_initialize(&codec->component,    //★注目その 2★
                        &codec_drv->component_driver, dev);
        if (ret)
                goto err_free;
...
        mutex_lock(&client_mutex);
        snd_soc_component_add_unlocked(&codec->component);    //★注目その 1★
        list_add(&codec->list, &codec_list);
        mutex_unlock(&client_mutex);
...

順序が逆転しますが、ゴールから逆にたどる形で説明します。まず component->regmap がどこから来たのか？を追います。答えは snd_soc_component_add_unlocked() にあります。

//linux-4.4/sound/soc/soc-core.c

static void snd_soc_component_add_unlocked(struct snd_soc_component *component)
{
        if (!component->write && !component->read) {
                if (!component->regmap)
                        component->regmap = dev_get_regmap(component->dev, NULL);
...


//linux-4.4/drivers/base/regmap/regmap.c

struct regmap *dev_get_regmap(struct device *dev, const char *name)
{
        struct regmap **r = devres_find(dev, dev_get_regmap_release,
                                        dev_get_regmap_match, (void *)name);
...


//linux-4.4/drivers/base/regmap/regmap.c

static int dev_get_regmap_match(struct device *dev, void *res, void *data)
{
        struct regmap **r = res;
...
        /* If the user didn't specify a name match any */
        if (data)
                return (*r)->name == data;
        else
                return 1;
...


//linux-4.4/drivers/base/devres.c

void * devres_find(struct device *dev, dr_release_t release,
                   dr_match_t match, void *match_data)
{
        struct devres *dr;
...
        dr = find_dr(dev, release, match, match_data);
...


//linux-4.4/drivers/base/devres.c

static struct devres *find_dr(struct device *dev, dr_release_t release,
                              dr_match_t match, void *match_data)
{
        struct devres_node *node;

        list_for_each_entry_reverse(node, &dev->devres_head, entry) {
                struct devres *dr = container_of(node, struct devres, node);

                if (node->release != release)
                        continue;
                //★今回は match に dev_get_regmap_match() を渡しています★
                //★また match_data には NULL を渡しています★
                //★dev_get_regmap_match() の第 3引数が NULL の場合、最初に見つけた regmap にヒットします★
                if (match && !match(dev, dr->data, match_data))
                        continue;
                return dr;
        }

        return NULL;
}

以上のように component->regmap は dev_get_regmap(component->dev, NULL) の結果を使っています。dev_get_regmap() の第 2引数 NULL なので、デバイスのリソース一覧（dev->devres_head）から、とにかく何でも良いので最初に見つけた regmap を返してくれという意味になります。

最初見たとき、関数名と中身が全然違うので、分かるわけねぇだろこんなの…って思いました。

次に component->dev はどこから来たのか？を追います。答えは snd_soc_component_initialize() にあります。

//linux-4.4/sound/soc/soc-core.c

static int snd_soc_component_initialize(struct snd_soc_component *component,
        const struct snd_soc_component_driver *driver, struct device *dev)
{
...
        component->dev = dev;    //★これです★
        component->driver = driver;
        component->probe = component->driver->probe;
        component->remove = component->driver->remove;

こちらはそんなに難しくないですね。

最後の疑問

ここまで調べてきて分かったことは、下記の通りです。

• ALSA の kcontrol は snd_soc_component_read() という関数でハードウェアのレジスタにアクセスしているようだ
• snd_component_read() は component->regmap を使う
• component->regmap はデバイス component->dev のリソースリストから探す
• component->dev は snd_soc_register_codec() に渡した dev を使う

ここで最後の疑問です。regmap を devres に追加する方法は？わからないですね。追加した覚えはありません。

でも絶対何かしているハズです。もう一回 TAS5086 のドライバに戻ってみます。

//linux-4.4/sound/soc/codecs/tas5086.c

static int tas5086_i2c_probe(struct i2c_client *i2c,
                             const struct i2c_device_id *id)
{
...
        priv->regmap = devm_regmap_init(dev, NULL, i2c, &tas5086_regmap);    //★もしかしてこれ？★
        if (IS_ERR(priv->regmap)) {
                ret = PTR_ERR(priv->regmap);
                dev_err(&i2c->dev, "Failed to create regmap: %d\n", ret);
                return ret;
        }
...
        if (ret == 0)
                ret = snd_soc_register_codec(&i2c->dev, &soc_codec_dev_tas5086,    //★snd_soc_codec_driver のポインタをここに渡している★
                                             &tas5086_dai, 1);

        return ret;
}

ざっと見ても regmap に何かしているのは devm_regmap_init() だけです。どうして devm_regmap_init() なのでしょうか？どうして regmap_init() ではダメなのでしょうか？

//linux-4.4/include/linux/regmap.h

#define devm_regmap_init(dev, bus, bus_context, config)                 \
        __regmap_lockdep_wrapper(__devm_regmap_init, #config,           \
                                dev, bus, bus_context, config)
//★__regmap_lockdep_wrapper() はロックを取って __devm_regmap_init() を呼ぶマクロ★


//linux-4.4/drivers/base/regmap/regmap.c

struct regmap *__devm_regmap_init(struct device *dev,
                                  const struct regmap_bus *bus,
                                  void *bus_context,
                                  const struct regmap_config *config,
                                  struct lock_class_key *lock_key,
                                  const char *lock_name)
{
        struct regmap **ptr, *regmap;

        ptr = devres_alloc(devm_regmap_release, sizeof(*ptr), GFP_KERNEL);
        if (!ptr)
                return ERR_PTR(-ENOMEM);

        //★regmap_init() も結局 __regmap_init() を呼ぶだけなのに何が違う？★
        regmap = __regmap_init(dev, bus, bus_context, config,
                               lock_key, lock_name);
        if (!IS_ERR(regmap)) {
                *ptr = regmap;
                devres_add(dev, ptr);    //★もしかしてこれ？★
        } else {
                devres_free(ptr);
        }

        return regmap;
}


//linux-4.4/drivers/base/devres.c

void devres_add(struct device *dev, void *res)
{
        struct devres *dr = container_of(res, struct devres, data);
        unsigned long flags;

        spin_lock_irqsave(&dev->devres_lock, flags);
        add_dr(dev, &dr->node);
        spin_unlock_irqrestore(&dev->devres_lock, flags);
}


//linux-4.4/drivers/base/devres.c

static void add_dr(struct device *dev, struct devres_node *node)
{
        devres_log(dev, node, "ADD");
        BUG_ON(!list_empty(&node->entry));
        list_add_tail(&node->entry, &dev->devres_head);    //★ここでリストに追加している！★
}

以上のように、devm_regmap_init() も regmap_init() も regmap 初期化という役割から見ると同等ですが、devm_regmap_init() はデバイスのリソースリスト（dev->devres_head）に regmap を登録するという役割も果たしています。

まとめ

まとめると、

• ALSA の kcontrol を使うときは regmap_init() ではなく、必ず devm_regmap_init() を使い、regmap をデバイスのリソースリストに足しましょう。
• regmap を登録したデバイスを snd_soc_register_codec() に渡しましょう。別のデバイスを渡してはいけません。

このルールだけ見れば難しくないですが、なぜこのルールなのか調べると、結構複雑でした。面白かったです。

ALSA のミキサーと regmap その 1

その 1、 その 2。

メモ代わりの超マニアックな話です。なぜ ALSA のドライバ、特にミキサーが regmap を使うのかを調べました。

ALSA のドライバでミュートの ON/OFF とか、ボリューム上げ下げの機能を実装するときに、kcontrol というフレームワークを使います。

ボリュームはさらにもう一つ仕組みがあって面倒なので、ミュート ON/OFF スイッチを例にします。下記は Texsas Instruments の TAS5711 という DAC のドライバです。

//from linux-4.4/sound/soc/codecs/tas571x.c

static const struct snd_kcontrol_new tas5711_controls[] = {
...
        SOC_DOUBLE("Speaker Switch",
                   TAS571X_SOFT_MUTE_REG,
                   TAS571X_SOFT_MUTE_CH1_SHIFT, TAS571X_SOFT_MUTE_CH2_SHIFT,
                   1, 1),
};

引数の意味はスイッチの名前（Speaker Switch）、レジスタのアドレス、L チャネルを制御するときのシフト数、R チャネルを制御するときのシフト数、最大値、反転するかどか、みたいです。

「反転するかどうか」を何に使っているかというと、通常 ON = max 値, OFF = min 値という意味ですが、ON = min 値, OFF = max 値にするようです。TI TAS5711 仕様書の SOFT MUTE REGISTER (0x06) を見た感じ、Mute するときは 1 設定しろとありますので、多分合っていると思います。間違ってたらごめんよ。

もちろんこれだけではダメで、struct snd_soc_codec_driver の controls にポインタを代入し、snd_soc_register_codec() に渡す必要があります。

どうも tas571x.c のドライバは TAS5711 と TAS5717 という 2つの DAC に対応するため、渡し方がちょっと変わってるので、TAS5086 用のドライバを見ます。

//from linux-4.4/sound/soc/codecs/tas5086.c

static const struct snd_kcontrol_new tas5086_controls[] = {
        SOC_SINGLE_TLV("Master Playback Volume", TAS5086_MASTER_VOL,
...

static struct snd_soc_codec_driver soc_codec_dev_tas5086 = {
        .probe                  = tas5086_probe,
        .remove                 = tas5086_remove,
        .suspend                = tas5086_soc_suspend,
        .resume                 = tas5086_soc_resume,
        .controls               = tas5086_controls,    //★snd_kcontrol_new 配列のポインタをここに渡している★
        .num_controls           = ARRAY_SIZE(tas5086_controls),
        .dapm_widgets           = tas5086_dapm_widgets,
        .num_dapm_widgets       = ARRAY_SIZE(tas5086_dapm_widgets),
        .dapm_routes            = tas5086_dapm_routes,
        .num_dapm_routes        = ARRAY_SIZE(tas5086_dapm_routes),
};

static int tas5086_i2c_probe(struct i2c_client *i2c,
                             const struct i2c_device_id *id)
{
...
        if (ret == 0)
                ret = snd_soc_register_codec(&i2c->dev, &soc_codec_dev_tas5086,    //★snd_soc_codec_driver のポインタをここに渡している★
                                             &tas5086_dai, 1);

        return ret;
}

こんな感じです。本当に言いたかったことは regmap ですけど、出てこないうちに終わってしまいました。また次回にします。