Merge remote-tracking branch 'md/for-next'
[deliverable/linux.git] / sound / soc / codecs / max9867.c
CommitLineData
805d132d 1/*
2 * max9867.c -- max9867 ALSA SoC Audio driver
3 *
4 * Copyright 2013-15 Maxim Integrated Products
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
10
11#include <linux/delay.h>
12#include <linux/i2c.h>
13#include <linux/module.h>
14#include <linux/regmap.h>
15#include <sound/pcm_params.h>
16#include <sound/soc.h>
17#include <sound/tlv.h>
18#include "max9867.h"
19
20static const char *const max9867_spmode[] = {
21 "Stereo Diff", "Mono Diff",
22 "Stereo Cap", "Mono Cap",
23 "Stereo Single", "Mono Single",
24 "Stereo Single Fast", "Mono Single Fast"
25};
26static const char *const max9867_sidetone_text[] = {
27 "None", "Left", "Right", "LeftRight", "LeftRightDiv2",
28};
29static const char *const max9867_filter_text[] = {"IIR", "FIR"};
30
31static SOC_ENUM_SINGLE_DECL(max9867_filter, MAX9867_CODECFLTR, 7,
32 max9867_filter_text);
33static SOC_ENUM_SINGLE_DECL(max9867_spkmode, MAX9867_MODECONFIG, 0,
34 max9867_spmode);
35static SOC_ENUM_SINGLE_DECL(max9867_sidetone, MAX9867_DACGAIN, 6,
36 max9867_sidetone_text);
37static DECLARE_TLV_DB_SCALE(max9860_capture_tlv, -600, 200, 0);
38static DECLARE_TLV_DB_SCALE(max9860_mic_tlv, 2000, 100, 1);
39static DECLARE_TLV_DB_SCALE(max9860_adc_left_tlv, -1200, 100, 1);
40static DECLARE_TLV_DB_SCALE(max9860_adc_right_tlv, -1200, 100, 1);
41static const unsigned int max98088_micboost_tlv[] = {
42 TLV_DB_RANGE_HEAD(2),
43 0, 1, TLV_DB_SCALE_ITEM(0, 2000, 0),
44 2, 2, TLV_DB_SCALE_ITEM(3000, 0, 0),
45};
46
47static const struct snd_kcontrol_new max9867_snd_controls[] = {
48 SOC_DOUBLE_R("Master Playback Volume", MAX9867_LEFTVOL,
49 MAX9867_RIGHTVOL, 0, 63, 1),
50 SOC_DOUBLE_R_TLV("Capture Volume", MAX9867_LEFTMICGAIN,
51 MAX9867_RIGHTMICGAIN,
52 0, 15, 1, max9860_capture_tlv),
53 SOC_DOUBLE_R_TLV("Mic Volume", MAX9867_LEFTMICGAIN,
54 MAX9867_RIGHTMICGAIN, 0, 31, 1, max9860_mic_tlv),
55 SOC_DOUBLE_R_TLV("Mic Boost Volume", MAX9867_LEFTMICGAIN,
56 MAX9867_RIGHTMICGAIN, 5, 3, 0, max98088_micboost_tlv),
57 SOC_ENUM("Digital Sidetone Src", max9867_sidetone),
58 SOC_SINGLE("Sidetone Volume", MAX9867_DACGAIN, 0, 31, 1),
59 SOC_SINGLE("DAC Volume", MAX9867_DACLEVEL, 4, 3, 0),
60 SOC_SINGLE("DAC Attenuation", MAX9867_DACLEVEL, 0, 15, 1),
61 SOC_SINGLE_TLV("ADC Left Volume", MAX9867_ADCLEVEL,
62 4, 15, 1, max9860_adc_left_tlv),
63 SOC_SINGLE_TLV("ADC Right Volume", MAX9867_ADCLEVEL,
64 0, 15, 1, max9860_adc_right_tlv),
65 SOC_ENUM("Speaker Mode", max9867_spkmode),
66 SOC_SINGLE("Volume Smoothing Switch", MAX9867_MODECONFIG, 6, 1, 0),
67 SOC_SINGLE("ZCD Switch", MAX9867_MODECONFIG, 5, 1, 0),
68 SOC_ENUM("DSP Filter", max9867_filter),
69};
70
71static const char *const max9867_mux[] = {"None", "Mic", "Line", "Mic_Line"};
72
73static SOC_ENUM_SINGLE_DECL(max9867_mux_enum,
74 MAX9867_INPUTCONFIG, MAX9867_INPUT_SHIFT,
75 max9867_mux);
76
77static const struct snd_kcontrol_new max9867_dapm_mux_controls =
78 SOC_DAPM_ENUM("Route", max9867_mux_enum);
79
80static const struct snd_kcontrol_new max9867_left_dapm_control =
81 SOC_DAPM_SINGLE("Switch", MAX9867_PWRMAN, 6, 1, 0);
82static const struct snd_kcontrol_new max9867_right_dapm_control =
83 SOC_DAPM_SINGLE("Switch", MAX9867_PWRMAN, 5, 1, 0);
84static const struct snd_kcontrol_new max9867_line_dapm_control =
85 SOC_DAPM_SINGLE("Switch", MAX9867_LEFTLINELVL, 6, 1, 1);
86
87static const struct snd_soc_dapm_widget max9867_dapm_widgets[] = {
88 SND_SOC_DAPM_AIF_IN("DAI_OUT", "HiFi Playback", 0, SND_SOC_NOPM, 0, 0),
89 SND_SOC_DAPM_DAC("Left DAC", NULL, MAX9867_PWRMAN, 3, 0),
90 SND_SOC_DAPM_DAC("Right DAC", NULL, MAX9867_PWRMAN, 2, 0),
91 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),
92 SND_SOC_DAPM_OUTPUT("HPOUT"),
93
94 SND_SOC_DAPM_AIF_IN("DAI_IN", "HiFi Capture", 0, SND_SOC_NOPM, 0, 0),
95 SND_SOC_DAPM_ADC("Left ADC", "HiFi Capture", MAX9867_PWRMAN, 1, 0),
96 SND_SOC_DAPM_ADC("Right ADC", "HiFi Capture", MAX9867_PWRMAN, 0, 0),
97 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0,
98 &max9867_dapm_mux_controls),
99
100 SND_SOC_DAPM_MIXER("Input Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),
101 SND_SOC_DAPM_SWITCH("Left Line", MAX9867_LEFTLINELVL, 6, 1,
102 &max9867_left_dapm_control),
103 SND_SOC_DAPM_SWITCH("Right Line", MAX9867_RIGTHLINELVL, 6, 1,
104 &max9867_right_dapm_control),
105 SND_SOC_DAPM_SWITCH("Line Mixer", SND_SOC_NOPM, 0, 0,
106 &max9867_line_dapm_control),
107 SND_SOC_DAPM_INPUT("LINE_IN"),
108};
109
110static const struct snd_soc_dapm_route max9867_audio_map[] = {
111 {"Left DAC", NULL, "DAI_OUT"},
112 {"Right DAC", NULL, "DAI_OUT"},
113 {"Output Mixer", NULL, "Left DAC"},
114 {"Output Mixer", NULL, "Right DAC"},
115 {"HPOUT", NULL, "Output Mixer"},
116
117 {"Left ADC", NULL, "DAI_IN"},
118 {"Right ADC", NULL, "DAI_IN"},
119 {"Input Mixer", NULL, "Left ADC"},
120 {"Input Mixer", NULL, "Right ADC"},
121 {"Input Mux", "Line", "Input Mixer"},
122 {"Input Mux", "Mic", "Input Mixer"},
123 {"Input Mux", "Mic_Line", "Input Mixer"},
124 {"Right Line", "Switch", "Input Mux"},
125 {"Left Line", "Switch", "Input Mux"},
126 {"LINE_IN", NULL, "Left Line"},
127 {"LINE_IN", NULL, "Right Line"},
128};
129
130enum rates {
131 pcm_rate_8, pcm_rate_16, pcm_rate_24,
132 pcm_rate_32, pcm_rate_44,
133 pcm_rate_48, max_pcm_rate,
134};
135
136struct ni_div_rates {
137 u32 mclk;
138 u16 ni[max_pcm_rate];
139} ni_div[] = {
140 {11289600, {0x116A, 0x22D4, 0x343F, 0x45A9, 0x6000, 0x687D} },
141 {12000000, {0x1062, 0x20C5, 0x3127, 0x4189, 0x5A51, 0x624E} },
142 {12288000, {0x1000, 0x2000, 0x3000, 0x4000, 0x5833, 0x6000} },
143 {13000000, {0x0F20, 0x1E3F, 0x2D5F, 0x3C7F, 0x535F, 0x5ABE} },
144 {19200000, {0x0A3D, 0x147B, 0x1EB8, 0x28F6, 0x3873, 0x3D71} },
145 {24000000, {0x1062, 0x20C5, 0x1893, 0x4189, 0x5A51, 0x624E} },
146 {26000000, {0x0F20, 0x1E3F, 0x16AF, 0x3C7F, 0x535F, 0x5ABE} },
147 {27000000, {0x0E90, 0x1D21, 0x15D8, 0x3A41, 0x5048, 0x5762} },
148};
149
150static inline int get_ni_value(int mclk, int rate)
151{
152 int i, ret = 0;
153
154 /* find the closest rate index*/
155 for (i = 0; i < ARRAY_SIZE(ni_div); i++) {
156 if (ni_div[i].mclk >= mclk)
157 break;
158 }
90966391
DC
159 if (i == ARRAY_SIZE(ni_div))
160 return -EINVAL;
805d132d 161
162 switch (rate) {
163 case 8000:
164 return ni_div[i].ni[pcm_rate_8];
165 case 16000:
166 return ni_div[i].ni[pcm_rate_16];
167 case 32000:
168 return ni_div[i].ni[pcm_rate_32];
169 case 44100:
170 return ni_div[i].ni[pcm_rate_44];
171 case 48000:
172 return ni_div[i].ni[pcm_rate_48];
173 default:
174 pr_err("%s wrong rate %d\n", __func__, rate);
175 ret = -EINVAL;
176 }
177 return ret;
178}
179
180static int max9867_dai_hw_params(struct snd_pcm_substream *substream,
181 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
182{
183 struct snd_soc_codec *codec = dai->codec;
184 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
127a9cbb
AH
185 unsigned int ni_h, ni_l;
186 int value;
805d132d 187
188 value = get_ni_value(max9867->sysclk, params_rate(params));
189 if (value < 0)
190 return value;
191
192 ni_h = (0xFF00 & value) >> 8;
193 ni_l = 0x00FF & value;
194 /* set up the ni value */
195 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKHIGH,
196 MAX9867_NI_HIGH_MASK, ni_h);
197 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKLOW,
198 MAX9867_NI_LOW_MASK, ni_l);
199 if (!max9867->master) {
200 /*
201 * digital pll locks on to any externally supplied LRCLK signal
202 * and also enable rapid lock mode.
203 */
204 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKLOW,
205 MAX9867_RAPID_LOCK, MAX9867_RAPID_LOCK);
206 regmap_update_bits(max9867->regmap, MAX9867_AUDIOCLKHIGH,
207 MAX9867_PLL, MAX9867_PLL);
208 } else {
209 unsigned long int bclk_rate, pclk_bclk_ratio;
210 int bclk_value;
211
9dcc72ef 212 bclk_rate = params_rate(params) * 2 * params_width(params);
805d132d 213 pclk_bclk_ratio = max9867->pclk/bclk_rate;
9dcc72ef 214 switch (params_width(params)) {
805d132d 215 case 8:
216 case 16:
b1461450 217 switch (pclk_bclk_ratio) {
218 case 2:
805d132d 219 bclk_value = MAX9867_IFC1B_PCLK_2;
b1461450 220 break;
221 case 4:
805d132d 222 bclk_value = MAX9867_IFC1B_PCLK_4;
b1461450 223 break;
224 case 8:
805d132d 225 bclk_value = MAX9867_IFC1B_PCLK_8;
b1461450 226 break;
227 case 16:
805d132d 228 bclk_value = MAX9867_IFC1B_PCLK_16;
b1461450 229 break;
230 default:
231 dev_err(codec->dev,
232 "unsupported sampling rate\n");
805d132d 233 return -EINVAL;
234 }
235 break;
236 case 24:
237 bclk_value = MAX9867_IFC1B_24BIT;
238 break;
239 case 32:
240 bclk_value = MAX9867_IFC1B_32BIT;
241 break;
242 default:
243 dev_err(codec->dev, "unsupported sampling rate\n");
244 return -EINVAL;
245 }
246 regmap_update_bits(max9867->regmap, MAX9867_IFC1B,
247 MAX9867_IFC1B_BCLK_MASK, bclk_value);
248 }
249 return 0;
250}
251
252static int max9867_prepare(struct snd_pcm_substream *substream,
253 struct snd_soc_dai *dai)
254{
255 struct snd_soc_codec *codec = dai->codec;
256 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
257
258 regmap_update_bits(max9867->regmap, MAX9867_PWRMAN,
259 MAX9867_SHTDOWN_MASK, MAX9867_SHTDOWN_MASK);
260 return 0;
261}
262
263static int max9867_mute(struct snd_soc_dai *dai, int mute)
264{
265 struct snd_soc_codec *codec = dai->codec;
266 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
267
268 if (mute)
269 regmap_update_bits(max9867->regmap, MAX9867_DACLEVEL,
270 MAX9867_DAC_MUTE_MASK, MAX9867_DAC_MUTE_MASK);
271 else
272 regmap_update_bits(max9867->regmap, MAX9867_DACLEVEL,
273 MAX9867_DAC_MUTE_MASK, 0);
274 return 0;
275}
276
277static int max9867_set_dai_sysclk(struct snd_soc_dai *codec_dai,
278 int clk_id, unsigned int freq, int dir)
279{
280 struct snd_soc_codec *codec = codec_dai->codec;
281 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
282 int value = 0;
283
284 /* Set the prescaler based on the master clock frequency*/
285 if (freq >= 10000000 && freq <= 20000000) {
286 value |= MAX9867_PSCLK_10_20;
287 max9867->pclk = freq;
288 } else if (freq >= 20000000 && freq <= 40000000) {
289 value |= MAX9867_PSCLK_20_40;
290 max9867->pclk = freq/2;
291 } else if (freq >= 40000000 && freq <= 60000000) {
292 value |= MAX9867_PSCLK_40_60;
293 max9867->pclk = freq/4;
294 } else {
295 pr_err("bad clock frequency %d", freq);
296 return -EINVAL;
297 }
298 value = value << MAX9867_PSCLK_SHIFT;
299 max9867->sysclk = freq;
300 /* exact integer mode is not supported */
301 value &= ~MAX9867_FREQ_MASK;
302 regmap_update_bits(max9867->regmap, MAX9867_SYSCLK,
303 MAX9867_PSCLK_MASK, value);
304 return 0;
305}
306
307static int max9867_dai_set_fmt(struct snd_soc_dai *codec_dai,
308 unsigned int fmt)
309{
310 struct snd_soc_codec *codec = codec_dai->codec;
311 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
312 u8 iface1A = 0, iface1B = 0;
313 int ret;
314
315 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
316 case SND_SOC_DAIFMT_CBM_CFM:
317 max9867->master = 1;
318 iface1A |= MAX9867_MASTER;
319 break;
320 case SND_SOC_DAIFMT_CBS_CFS:
321 max9867->master = 0;
322 iface1A &= ~MAX9867_MASTER;
323 break;
324 default:
325 return -EINVAL;
326 }
327
328 /* for i2s compatible mode */
329 iface1A |= MAX9867_I2S_DLY;
330 /* SDOUT goes to hiz state after all data is transferred */
331 iface1A |= MAX9867_SDOUT_HIZ;
332
333 /* Clock inversion bits, BCI and WCI */
334 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
335 case SND_SOC_DAIFMT_NB_NF:
336 break;
337 case SND_SOC_DAIFMT_IB_IF:
338 iface1A |= MAX9867_WCI_MODE | MAX9867_BCI_MODE;
339 break;
340 case SND_SOC_DAIFMT_IB_NF:
341 iface1A |= MAX9867_BCI_MODE;
342 break;
343 case SND_SOC_DAIFMT_NB_IF:
344 iface1A |= MAX9867_WCI_MODE;
345 break;
346 default:
347 return -EINVAL;
348 }
349
350 ret = regmap_write(max9867->regmap, MAX9867_IFC1A, iface1A);
351 ret = regmap_write(max9867->regmap, MAX9867_IFC1B, iface1B);
352 return 0;
353}
354
355static struct snd_soc_dai_ops max9867_dai_ops = {
356 .set_fmt = max9867_dai_set_fmt,
357 .set_sysclk = max9867_set_dai_sysclk,
358 .prepare = max9867_prepare,
359 .digital_mute = max9867_mute,
360 .hw_params = max9867_dai_hw_params,
361};
362
363#define MAX9867_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_16000 |\
364 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
365#define MAX9867_FORMATS (SNDRV_PCM_FMTBIT_S16_LE)
366
367static struct snd_soc_dai_driver max9867_dai[] = {
368 {
369 .name = "max9867-aif1",
370 .playback = {
371 .stream_name = "HiFi Playback",
372 .channels_min = 1,
373 .channels_max = 2,
374 .rates = MAX9867_RATES,
375 .formats = MAX9867_FORMATS,
376 },
377 .capture = {
378 .stream_name = "HiFi Capture",
379 .channels_min = 1,
380 .channels_max = 2,
381 .rates = MAX9867_RATES,
382 .formats = MAX9867_FORMATS,
383 },
384 .ops = &max9867_dai_ops,
385 }
386};
387
388#ifdef CONFIG_PM_SLEEP
389static int max9867_suspend(struct device *dev)
390{
391 struct max9867_priv *max9867 = dev_get_drvdata(dev);
392
393 /* Drop down to power saving mode when system is suspended */
394 regmap_update_bits(max9867->regmap, MAX9867_PWRMAN,
395 MAX9867_SHTDOWN_MASK, ~MAX9867_SHTDOWN_MASK);
396 return 0;
397}
398
399static int max9867_resume(struct device *dev)
400{
401 struct max9867_priv *max9867 = dev_get_drvdata(dev);
402
403 regmap_update_bits(max9867->regmap, MAX9867_PWRMAN,
404 MAX9867_SHTDOWN_MASK, MAX9867_SHTDOWN_MASK);
405 return 0;
406}
407#endif
408
409static int max9867_probe(struct snd_soc_codec *codec)
410{
411 struct max9867_priv *max9867 = snd_soc_codec_get_drvdata(codec);
412
413 dev_dbg(codec->dev, "max98090_probe\n");
414 max9867->codec = codec;
415 return 0;
416}
417
418static struct snd_soc_codec_driver max9867_codec = {
419 .probe = max9867_probe,
e92b48aa
KM
420 .component_driver = {
421 .controls = max9867_snd_controls,
422 .num_controls = ARRAY_SIZE(max9867_snd_controls),
423 .dapm_routes = max9867_audio_map,
424 .num_dapm_routes = ARRAY_SIZE(max9867_audio_map),
425 .dapm_widgets = max9867_dapm_widgets,
426 .num_dapm_widgets = ARRAY_SIZE(max9867_dapm_widgets),
427 },
805d132d 428};
429
430static bool max9867_volatile_register(struct device *dev, unsigned int reg)
431{
432 switch (reg) {
433 case MAX9867_STATUS:
434 case MAX9867_JACKSTATUS:
435 case MAX9867_AUXHIGH:
436 case MAX9867_AUXLOW:
437 return true;
438 default:
439 return false;
440 }
441}
442
250a99e7 443static const struct reg_default max9867_reg[] = {
805d132d 444 { 0x04, 0x00 },
445 { 0x05, 0x00 },
446 { 0x06, 0x00 },
447 { 0x07, 0x00 },
448 { 0x08, 0x00 },
449 { 0x09, 0x00 },
450 { 0x0A, 0x00 },
451 { 0x0B, 0x00 },
452 { 0x0C, 0x00 },
453 { 0x0D, 0x00 },
454 { 0x0E, 0x00 },
455 { 0x0F, 0x00 },
456 { 0x10, 0x00 },
457 { 0x11, 0x00 },
458 { 0x12, 0x00 },
459 { 0x13, 0x00 },
460 { 0x14, 0x00 },
461 { 0x15, 0x00 },
462 { 0x16, 0x00 },
463 { 0x17, 0x00 },
464};
465
250a99e7 466static const struct regmap_config max9867_regmap = {
805d132d 467 .reg_bits = 8,
468 .val_bits = 8,
469 .max_register = MAX9867_REVISION,
470 .reg_defaults = max9867_reg,
471 .num_reg_defaults = ARRAY_SIZE(max9867_reg),
472 .volatile_reg = max9867_volatile_register,
473 .cache_type = REGCACHE_RBTREE,
474};
475
476static int max9867_i2c_probe(struct i2c_client *i2c,
477 const struct i2c_device_id *id)
478{
479 struct max9867_priv *max9867;
480 int ret = 0, reg;
481
482 max9867 = devm_kzalloc(&i2c->dev,
483 sizeof(*max9867), GFP_KERNEL);
484 if (!max9867)
485 return -ENOMEM;
486
487 i2c_set_clientdata(i2c, max9867);
488 max9867->regmap = devm_regmap_init_i2c(i2c, &max9867_regmap);
489 if (IS_ERR(max9867->regmap)) {
490 ret = PTR_ERR(max9867->regmap);
491 dev_err(&i2c->dev,
492 "Failed to allocate regmap: %d\n", ret);
493 return ret;
494 }
495 ret = regmap_read(max9867->regmap,
496 MAX9867_REVISION, &reg);
497 if (ret < 0) {
498 dev_err(&i2c->dev, "Failed to read: %d\n", ret);
499 return ret;
500 }
501 dev_info(&i2c->dev, "device revision: %x\n", reg);
502 ret = snd_soc_register_codec(&i2c->dev, &max9867_codec,
503 max9867_dai, ARRAY_SIZE(max9867_dai));
504 if (ret < 0) {
505 dev_err(&i2c->dev, "Failed to register codec: %d\n", ret);
506 return ret;
507 }
508 return ret;
509}
510
511static int max9867_i2c_remove(struct i2c_client *client)
512{
513 snd_soc_unregister_codec(&client->dev);
514 return 0;
515}
516
517static const struct i2c_device_id max9867_i2c_id[] = {
518 { "max9867", 0 },
1b36e4a2 519 { }
805d132d 520};
521
522static const struct of_device_id max9867_of_match[] = {
523 { .compatible = "maxim,max9867", },
524 { }
525};
526
527MODULE_DEVICE_TABLE(i2c, max9867_i2c_id);
528
529static const struct dev_pm_ops max9867_pm_ops = {
530 SET_SYSTEM_SLEEP_PM_OPS(max9867_suspend, max9867_resume)
531};
532
533static struct i2c_driver max9867_i2c_driver = {
534 .driver = {
535 .name = "max9867",
536 .of_match_table = of_match_ptr(max9867_of_match),
537 .pm = &max9867_pm_ops,
538 },
539 .probe = max9867_i2c_probe,
540 .remove = max9867_i2c_remove,
541 .id_table = max9867_i2c_id,
542};
543
544module_i2c_driver(max9867_i2c_driver);
545
546MODULE_AUTHOR("anish kumar <yesanishhere@gmail.com>");
547MODULE_DESCRIPTION("ALSA SoC MAX9867 driver");
548MODULE_LICENSE("GPL");
This page took 0.075848 seconds and 5 git commands to generate.