Linux Audio

Check our new training course

Loading...
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
/*
 * Copyright (c) 2020 Nuvoton Technology Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef _NUVOTON_NPCX_SOC_DT_H_
#define _NUVOTON_NPCX_SOC_DT_H_

/**
 * @brief Like DT_PROP(), but expand parameters with
 *        DT_ENUM_UPPER_TOKEN not DT_PROP
 *
 * If the prop exists, this expands to DT_ENUM_UPPER_TOKEN(node_id, prop).
 * The default_value parameter is not expanded in this case.
 *
 * Otherwise, this expands to default_value.
 *
 * @param node_id node identifier
 * @param prop lowercase-and-underscores property name
 * @param default_value a fallback value to expand to
 * @return the property's enum upper token value or default_value
 */
#define NPCX_DT_PROP_ENUM_OR(node_id, prop, default_value) \
	COND_CODE_1(DT_NODE_HAS_PROP(node_id, prop), \
		    (DT_STRING_UPPER_TOKEN(node_id, prop)), (default_value))

/**
 * @brief Like DT_INST_PROP_OR(), but expand parameters with
 *        NPCX_DT_PROP_ENUM_OR not DT_PROP_OR
 * @param inst instance number
 * @param prop lowercase-and-underscores property name
 * @param default_value a fallback value to expand to
 * @return the property's enum upper token value or default_value
 */
#define NPCX_DT_INST_PROP_ENUM_OR(inst, prop, default_value) \
	NPCX_DT_PROP_ENUM_OR(DT_DRV_INST(inst), prop, default_value)

/**
 * @brief Construct a npcx_clk_cfg item from first item in 'clocks' prop which
 * type is 'phandle-array' to handle "clock-cells" in current driver.
 *
 * Example devicetree fragment:
 *    / {
 *		uart1: serial@400c4000 {
 *			clocks = <&pcc NPCX_CLOCK_BUS_APB2 NPCX_PWDWN_CTL1 4>;
 *			...
 *		};
 *	};
 *
 * Example usage:
 *      const struct npcx_clk_cfg clk_cfg = NPCX_DT_CLK_CFG_ITEM(inst);
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return npcx_clk_cfg item.
 */
#define NPCX_DT_CLK_CFG_ITEM(inst)                                             \
	{                                                                      \
	  .bus  = NPCX_DT_INST_PROP_ENUM_OR(inst, clock_bus,                   \
				DT_PHA(DT_DRV_INST(inst), clocks, bus)),       \
	  .ctrl = DT_PHA(DT_DRV_INST(inst), clocks, ctl),                      \
	  .bit  = DT_PHA(DT_DRV_INST(inst), clocks, bit),                      \
	}

/**
 * @brief Construct a npcx_clk_cfg structure from 'clocks' property at index 'i'
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @param i index of clocks prop which type is 'phandle-array'
 * @return npcx_clk_cfg item from 'clocks' property at index 'i'
 */
#define NPCX_DT_CLK_CFG_ITEM_BY_IDX(inst, i)                                   \
	{                                                                      \
	  .bus  = DT_CLOCKS_CELL_BY_IDX(DT_DRV_INST(inst), i, bus),            \
	  .ctrl = DT_CLOCKS_CELL_BY_IDX(DT_DRV_INST(inst), i, ctl),            \
	  .bit  = DT_CLOCKS_CELL_BY_IDX(DT_DRV_INST(inst), i, bit),            \
	},

/**
 * @brief Length of 'clocks' property which type is 'phandle-array'
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return length of 'clocks' property which type is 'phandle-array'
 */
#define NPCX_DT_CLK_CFG_ITEMS_LEN(inst) DT_INST_PROP_LEN(inst, clocks)

/**
 * @brief Macro function to construct npcx_clk_cfg item in UTIL_LISTIFY
 * extension.
 *
 * @param child child index in UTIL_LISTIFY extension.
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return macro function to construct a npcx_clk_cfg structure.
 */
#define NPCX_DT_CLK_CFG_ITEMS_FUNC(child, inst) \
					NPCX_DT_CLK_CFG_ITEM_BY_IDX(inst, child)

/**
 * @brief Macro function to construct a list of npcx_clk_cfg items by
 * UTIL_LISTIFY func
 *
 * Example devicetree fragment:
 *    / {
 *		host_sub: lpc@400c1000 {
 *			clocks = <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 3>,
 *				 <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 4>,
 *				 <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 5>,
 *				 <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 6>,
 *				 <&pcc NPCX_CLOCK_BUS_APB3 NPCX_PWDWN_CTL5 7>;
 *			...
 *		};
 * Example usage:
 *	const struct npcx_clk_cfg clk_cfg[] = NPCX_DT_CLK_CFG_ITEMS_LIST(0);
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return an array of npcx_clk_cfg items.
 */
#define NPCX_DT_CLK_CFG_ITEMS_LIST(inst) {             \
	UTIL_LISTIFY(NPCX_DT_CLK_CFG_ITEMS_LEN(inst),  \
		     NPCX_DT_CLK_CFG_ITEMS_FUNC,       \
		     inst)                             \
	}

/**
 * @brief Construct a npcx_alt structure from 'pinctrl-0' property at index 'i'
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @param i index of 'pinctrl-0' prop which type is 'phandles'
 * @return npcx_alt item from 'pinctrl-0' property at index 'i'
 */
#define NPCX_DT_ALT_ITEM_BY_IDX(inst, i)				   \
	{								   \
		.group = DT_PHA(DT_INST_PINCTRL_0(inst, i), alts, group),  \
		.bit = DT_PHA(DT_INST_PINCTRL_0(inst, i), alts, bit),	   \
		.inverted = DT_PHA(DT_INST_PINCTRL_0(inst, i), alts, inv), \
	},

/**
 * @brief Macro function to construct npcx_alt item in UTIL_LISTIFY extension.
 *
 * @param child child index in UTIL_LISTIFY extension.
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return macro function to construct a npcx_alt structure.
 */
#define NPCX_DT_ALT_ITEMS_FUNC(child, inst) NPCX_DT_ALT_ITEM_BY_IDX(inst, child)

/**
 * @brief Macro function to construct a list of npcx_alt items with compatible
 * defined in DT_DRV_COMPAT by UTIL_LISTIFY func
 *
 * Example devicetree fragment:
 *    / {
 *		uart1: serial@400c4000 {
 *			pinctrl-0 = <&alta_uart1_sl1>;
 *			...
 *		};
 *	};
 *
 * Example usage:
 *      const struct npcx_alt uart_alts[] = NPCX_DT_ALT_ITEMS_LIST(inst);
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return an array of npcx_alt items.
 */
#define NPCX_DT_ALT_ITEMS_LIST(inst) {				\
	UTIL_LISTIFY(DT_INST_NUM_PINCTRLS_BY_IDX(inst, 0),	\
		     NPCX_DT_ALT_ITEMS_FUNC,			\
		     inst)					\
	}

/**
 * @brief Node identifier for an instance of a specific compatible
 *
 * @param compat specific compatible of devices in device-tree file
 * @param inst instance number
 * @return a node identifier for the node with "io_comp" compatible and
 *         instance number "inst"
 */
#define NPCX_DT_COMP_INST(compat, inst) DT_INST(inst, compat)

/**
 * @brief Get a specific compatible instance's node identifier for a phandle in
 * a property.
 *
 * @param compat specific compatible of devices in device-tree file
 * @param inst instance number
 * @param prop lowercase-and-underscores property name in "inst"
 *             with type "phandle", "phandles" or "phandle-array"
 * @param idx index into "prop"
 * @return a node identifier for the phandle at index "idx" in "prop"
 */
#define NPCX_DT_COMP_INST_PHANDLE_BY_IDX(compat, inst, prop, idx) \
	DT_PHANDLE_BY_IDX(NPCX_DT_COMP_INST(compat, inst), prop, idx)

/**
 * @brief Get phandle from 'pinctrl-0' prop which type is 'phandles' at index
 *        'i' from io-pads device with specific compatible.
 *
 * @param io_comp compatible string in devicetree file for io-pads device
 * @param inst instance number for compatible defined in io_comp.
 * @param i index of 'pinctrl-0' prop which type is 'phandles'
 * @return phandle from 'pinctrl-0' prop at index 'i'
 */
#define NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i) \
	DT_PINCTRL_BY_IDX(NPCX_DT_COMP_INST(io_comp, inst), 0, i)

/**
 * @brief Construct a npcx_alt structure from 'pinctrl-0' property at index 'i'
 *        from io-pads device with specific compatible.
 *
 * @param io_comp compatible string in devicetree file for io-pads device
 * @param inst instance number for compatible defined in io_comp.
 * @param i index of 'pinctrl-0' prop which type is 'phandles'
 * @return npcx_alt item from 'pinctrl-0' property at index 'i'
 */
#define NPCX_DT_IO_ALT_ITEM_BY_IDX(io_comp, inst, i)                           \
	{                                                                      \
	  .group = DT_PHA(NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i),   \
								alts, group),  \
	  .bit = DT_PHA(NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i),     \
								alts, bit),    \
	  .inverted = DT_PHA(NPCX_DT_IO_PHANDLE_FROM_PINCTRL(io_comp, inst, i),\
								alts, inv),    \
	},

/**
 * @brief Length of npcx_alt structures in 'pinctrl-0' property of specific
 *        compatible io-pads device
 *
 * @param io_comp compatible string in devicetree file for io-pads device
 * @param inst instance number for compatible defined in io_comp.
 * @return length of 'pinctrl-0' property which type is 'phandles'
 */
#define NPCX_DT_IO_ALT_ITEMS_LEN(io_comp, inst) \
	DT_NUM_PINCTRLS_BY_IDX(NPCX_DT_COMP_INST(io_comp, inst), 0)

/**
 * @brief Macro function to construct npcx_alt item with specific compatible
 *        string in UTIL_LISTIFY extension.
 *
 * @param child child index in UTIL_LISTIFY extension.
 * @param inst instance number for compatible defined in io_comp.
 * @param io_comp compatible string in devicetree file for io-pads device
 * @return macro function to construct a npcx_alt structure.
 */
#define NPCX_DT_IO_ALT_ITEMS_FUNC(child, inst, io_comp) \
			NPCX_DT_IO_ALT_ITEM_BY_IDX(io_comp, inst, child)

/**
 * @brief Macro function to construct a list of npcx_alt items with specific
 *        compatible string by UTIL_LISTIFY func
 *
 * Example devicetree fragment:
 *    / {
 *		host_uart: io_host_uart {
 *			compatible = "nuvoton,npcx-host-uart";
 *
 *			pinctrl-0 = <&altb_rxd_sl &altb_txd_sl
 *				   &altb_rts_sl &altb_cts_sl
 *				   &altb_ri_sl &altb_dtr_bout_sl
 *				   &altb_dcd_sl &altb_dsr_sl>;
 *			...
 *		};
 *	};
 *
 * Example usage:
 *      const struct npcx_alt host_uart_alts[] =
 *                   NPCX_DT_IO_ALT_ITEMS_LIST(nuvoton_npcx_host_uart, 0);
 * @param io_comp compatible string in devicetree file for io-pads device
 * @param inst instance number for compatible defined in io_comp.
 * @return an array of npcx_alt items.
 */
#define NPCX_DT_IO_ALT_ITEMS_LIST(io_comp, inst) {             \
	UTIL_LISTIFY(NPCX_DT_IO_ALT_ITEMS_LEN(io_comp, inst),  \
		     NPCX_DT_IO_ALT_ITEMS_FUNC,                \
		     inst, io_comp)                            \
	}

/**
 * @brief Get phandle from "name" property which contains wui information.
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @param name property 'name' which type is 'phandle' and contains wui info.
 * @return phandle from 'name' property.
 */
#define NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, name) \
	DT_INST_PHANDLE(inst, name)

/**
 * @brief Construct a npcx_wui structure from 'name' property
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @param name property 'name'which type is 'phandle' and contains wui info.
 * @return npcx_wui item from 'name' property.
 */
#define NPCX_DT_WUI_ITEM_BY_NAME(inst, name)				       \
	{                                                                      \
	  .table = DT_PROP(DT_PHANDLE(NPCX_DT_PHANDLE_FROM_WUI_NAME(inst,      \
					name), miwus), index),                 \
	  .group = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, name), miwus,    \
					group),                                \
	  .bit   = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, name), miwus,    \
					bit),                                  \
	}

/**
 * @brief Get phandle from 'wui-maps' prop which type is 'phandles' at index 'i'
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @param i index of 'wui-maps' prop which type is 'phandles'
 * @return phandle from 'wui-maps' prop at index 'i'
 */
#define NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i) \
	DT_INST_PHANDLE_BY_IDX(inst, wui_maps, i)

/**
 * @brief Construct a npcx_wui structure from wui-maps property at index 'i'
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @param i index of 'wui-maps' prop which type is 'phandles'
 * @return npcx_wui item at index 'i'
 */
#define NPCX_DT_WUI_ITEM_BY_IDX(inst, i) \
	{                                                                      \
	  .table = DT_PROP(DT_PHANDLE(NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i),  \
					miwus), index),                        \
	  .group = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i), miwus,       \
							group),                \
	  .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_WUI_MAPS(inst, i), miwus, bit),   \
	},

/**
 * @brief Length of npcx_wui structures in 'wui-maps' property
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return length of 'wui-maps' prop which type is 'phandles'
 */
#define NPCX_DT_WUI_ITEMS_LEN(inst) DT_INST_PROP_LEN(inst, wui_maps)

/**
 * @brief Macro function to construct a list of npcx_wui items by UTIL_LISTIFY
 *
 * @param child child index in UTIL_LISTIFY extension.
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return macro function to construct a npcx_wui structure.
 */
#define NPCX_DT_WUI_ITEMS_FUNC(child, inst) NPCX_DT_WUI_ITEM_BY_IDX(inst, child)

/**
 * @brief Macro function to construct a list of npcx_wui items by UTIL_LISTIFY
 * func.
 *
 * Example devicetree fragment:
 *    / {
 *		uart1: serial@400c4000 {
 *			uart-rx = <&wui_cr_sin1>;
 *			...
 *		};
 *
 *		gpio0: gpio@40081000 {
 *			wui-maps = <&wui_io00 &wui_io01 &wui_io02 &wui_io03
 *				    &wui_io04 &wui_io05 &wui_io06 &wui_io07>;
 *			...
 *		};
 *	};
 *
 * Example usage:
 * const struct npcx_wui wui_map = NPCX_DT_PHANDLE_FROM_WUI_NAME(inst, uart_rx);
 * const struct npcx_wui wui_maps[] = NPCX_DT_WUI_ITEMS_LIST(inst);
 *
 * @param inst instance number for compatible defined in DT_DRV_COMPAT.
 * @return an array of npcx_wui items.
 */
#define NPCX_DT_WUI_ITEMS_LIST(inst) {             \
	UTIL_LISTIFY(NPCX_DT_WUI_ITEMS_LEN(inst),  \
		     NPCX_DT_WUI_ITEMS_FUNC,       \
		     inst)                         \
	}

/**
 * @brief Get a node from path '/npcx_miwus_map/map_miwu(0/1/2)_groups'
 *
 * @param i index of npcx miwu devices
 * @return node identifier with that path.
 */
#define NPCX_DT_NODE_FROM_MIWU_MAP(i)  DT_PATH(npcx_miwus_int_map, \
						map_miwu##i##_groups)
/**
 * @brief Get the index prop from parent MIWU device node.
 *
 * @param child index in UTIL_LISTIFY extension.
 * @return 'index' prop value of the node which compatible type is
 * "nuvoton,npcx-miwu".
 */
#define NPCX_DT_MIWU_IRQ_TABLE_IDX(child) \
	DT_PROP(DT_PHANDLE(DT_PARENT(child), parent), index)

/**
 * @brief Macro function for DT_FOREACH_CHILD to generate a IRQ_CONNECT
 * implementation.
 *
 * @param child index in UTIL_LISTIFY extension.
 * @return implementation to initialize interrupts of MIWU groups and enable
 * them.
 */
#define NPCX_DT_MIWU_IRQ_CONNECT_IMPL_CHILD_FUNC(child) \
	NPCX_DT_MIWU_IRQ_CONNECT_IMPL_CHILD_FUNC_OBJ(child);

#define NPCX_DT_MIWU_IRQ_CONNECT_IMPL_CHILD_FUNC_OBJ(child) \
	do {                                                                   \
		IRQ_CONNECT(DT_PROP(child, irq),		               \
			DT_PROP(child, irq_prio),		               \
			NPCX_MIWU_ISR_FUNC(NPCX_DT_MIWU_IRQ_TABLE_IDX(child)), \
			DT_PROP(child, group_mask),                            \
			0);						       \
		irq_enable(DT_PROP(child, irq));                               \
	} while (0)

/**
 * @brief Get a child node from path '/npcx-espi-vws-map/name'.
 *
 * @param name a path which name is /npcx-espi-vws-map/'name'.
 * @return child node identifier with that path.
 */
#define NPCX_DT_NODE_FROM_VWTABLE(name) DT_CHILD(DT_PATH(npcx_espi_vws_map),  \
									name)

/**
 * @brief Get phandle from vw-wui property of child node with that path.
 *
 * @param name path which name is /npcx-espi-vws-map/'name'.
 * @return phandle from "vw-wui" prop of child node with that path.
 */
#define NPCX_DT_PHANDLE_VW_WUI(name) DT_PHANDLE(NPCX_DT_NODE_FROM_VWTABLE(     \
								name), vw_wui)

/**
 * @brief Construct a npcx_wui structure from vw-wui property of a child node
 * with that path.
 *
 * @param name a path which name is /npcx-espi-vws-map/'name'.
 * @return npcx_wui item with that path.
 */
#define NPCX_DT_VW_WUI_ITEM(name)			                       \
	{                                                                      \
	  .table = DT_PROP(DT_PHANDLE(NPCX_DT_PHANDLE_VW_WUI(name), miwus),    \
									index),\
	  .group = DT_PHA(NPCX_DT_PHANDLE_VW_WUI(name), miwus, group),         \
	  .bit = DT_PHA(NPCX_DT_PHANDLE_VW_WUI(name), miwus, bit),             \
	}

/**
 * @brief Construct a npcx espi device configuration of vw input signal from
 * a child node with that path.
 *
 * @signal vw input signal name.
 * @param name a path which name is /npcx-espi-vws-map/'name'.
 * @return npcx_vw_in_config item with that path.
 */
#define NPCX_DT_VW_IN_CONF(signal, name)                                       \
	{                                                                      \
	  .sig = signal,                                                       \
	  .reg_idx = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg,   \
									0),    \
	  .bitmask = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg,   \
									1),    \
	  .vw_wui  = NPCX_DT_VW_WUI_ITEM(name),                                \
	}

/**
 * @brief Construct a npcx espi device configuration of vw output signal from
 * a child node with that path.
 *
 * @signal vw output signal name.
 * @param name a path which name is /npcx-espi-vws-map/'name'.
 * @return npcx_vw_in_config item with that path.
 */
#define NPCX_DT_VW_OUT_CONF(signal, name)                                      \
	{                                                                      \
	  .sig = signal,                                                       \
	  .reg_idx = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg,   \
									0),    \
	  .bitmask = DT_PROP_BY_IDX(NPCX_DT_NODE_FROM_VWTABLE(name), vw_reg,   \
									1),    \
	}

/**
 * @brief Get a node from path '/def_lvol_io_list' which has a property
 *        'lvol-io-pads' contains low-voltage configurations and need to set
 *        by default.
 *
 * @return node identifier with that path.
 */
#define NPCX_DT_NODE_DEF_LVOL_LIST  DT_PATH(def_lvol_io_list)

/**
 * @brief Length of npcx_lvol structures in 'lvol-io-pads' property
 *
 * @return length of 'lvol-io-pads' prop which type is 'phandles'
 */
#define NPCX_DT_LVOL_ITEMS_LEN DT_PROP_LEN(NPCX_DT_NODE_DEF_LVOL_LIST, \
								lvol_io_pads)

/**
 * @brief Get phandle from 'lvol-io-pads' prop which type is 'phandles' at index
 *        'i'
 *
 * @param i index of 'lvol-io-pads' prop which type is 'phandles'
 * @return phandle from 'lvol-io-pads' prop at index 'i'
 */
#define NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i) \
	DT_PHANDLE_BY_IDX(NPCX_DT_NODE_DEF_LVOL_LIST, lvol_io_pads, i)

/**
 * @brief Construct a npcx_lvol structure from 'lvol-io-pads' property at index
 *        'i'.
 *
 * @param i index of 'lvol-io-pads' prop which type is 'phandles'
 * @return npcx_lvol item from 'lvol-io-pads' property at index 'i'
 */
#define NPCX_DT_LVOL_ITEMS_BY_IDX(i, _)                                        \
	{                                                                      \
	  .io_port = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i),              \
							lvols, io_port),       \
	  .io_bit = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i),               \
							lvols, io_bit),        \
	  .ctrl = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i),                 \
							lvols, ctrl),          \
	  .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_LVOL_IO_PADS(i),                  \
							lvols, bit),           \
	},

/**
 * @brief Macro function to construct a list of npcx_lvol items by UTIL_LISTIFY
 *        func.
 *
 * Example devicetree fragment:
 *    / {
 *          def_lvol_io_list {
 *              compatible = "nuvoton,npcx-lvolctrl-def";
 *              lvol-io-pads = <&lvol_io90   // I2C1_SCL0 1.8V support
 *                              &lvol_io87>; // I2C1_SDA0 1,8V support
 *          };
 *	};
 *
 * Example usage:
 * static const struct npcx_lvol def_lvols[] = NPCX_DT_IO_LVOL_ITEMS_DEF_LIST;
 *
 * @return an array of npcx_lvol items which configure low-voltage support
 */
#define NPCX_DT_IO_LVOL_ITEMS_DEF_LIST {                \
		UTIL_LISTIFY(NPCX_DT_LVOL_ITEMS_LEN,    \
			NPCX_DT_LVOL_ITEMS_BY_IDX, _)   \
	}

/**
 * @brief Get a node from path '/vsby-psl-in-list' which has a property
 *        'psl-in-pads' contains Power Switch Logic (PSL) input pads which are
 *        in charge of detecting wake-up events on VSBY power domain.
 *
 * @return node identifier with that path.
 */
#define NPCX_DT_NODE_PSL_IN_LIST  DT_PATH(vsby_psl_in_list)

/**
 * @brief Length of npcx_psl_in structures in 'psl-in-pads' property
 *
 * @return length of 'psl-in-pads' prop which type is 'phandles'
 */
#define NPCX_DT_PSL_IN_ITEMS_LEN DT_PROP_LEN(NPCX_DT_NODE_PSL_IN_LIST, \
								psl_in_pads)

/**
 * @brief Get phandle from 'psl-in-pads' prop which type is 'phandles' at index
 *        'i'
 *
 * @param i index of 'psl-in-pads' prop which type is 'phandles'
 * @return phandle from 'psl-in-pads' prop at index 'i'
 */
#define NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i) \
	DT_PHANDLE_BY_IDX(NPCX_DT_NODE_PSL_IN_LIST, psl_in_pads, i)

/**
 * @brief Get phandle from 'pinctrl-0' prop which type is 'phandles' at index
 *        'i'
 *
 * @param i index of 'psl-in-pads' prop which type is 'phandles'
 * @return phandle from 'pinctrl-0' prop at index 'i'
 */
#define NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i) \
	DT_PINCTRL_0(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), 0)

/**
 * @brief Get phandle from 'polarity-0' prop which type is 'phandles' at index
 *        'i'
 *
 * @param i index of 'psl-in-pads' prop which type is 'phandles'
 * @return phandle from 'polarity-0' prop at index 'i'
 */
#define NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i) \
	DT_PHANDLE(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), polarity_0)

/**
 * @brief Construct a npcx_alt structure from 'pinctrl-0' property at index 'i'
 *        of 'psl-in-pads' prop.
 *
 * @param i index of 'psl-in-pads' prop which type is 'phandles'
 * @return npcx_alt item from 'pinctrl-0' property at index 'i'
 */
#define NPCX_DT_PSL_IN_ALT_CONF_BY_IDX(i)                                         \
	{                                                                         \
	  .group = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i), alts, group),  \
	  .bit = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i), alts, bit),      \
	  .inverted = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_PINMUX_NODE(i), alts, inv), \
	},

/**
 * @brief Construct a npcx_alt structure from 'polarity-0' property at index 'i'
 *        of 'psl-in-pads' prop.
 *
 * @param i index of 'psl-in-pads' prop which type is 'phandles'
 * @return npcx_alt item from 'pinctrl-0' property at index 'i'
 */
#define NPCX_DT_PSL_IN_POL_CONF_BY_IDX(i)                                                 \
	{                                                                                 \
		.group = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i), alts, group),  \
		.bit = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i), alts, bit),      \
		.inverted = DT_PHA(NPCX_DT_PHANDLE_FROM_PSL_POLARITY_NODE(i), alts, inv), \
	},

/**
 * @brief Construct a npcx_psl_in structure from 'psl-in-pads' property at index
 *        'i'
 *
 * @param i index of 'psl-in-pads' prop which type is 'phandles'
 * @return npcx_psl_in item from 'psl-in-pads' property at index 'i'
 */
#define NPCX_DT_PSL_IN_ITEMS_BY_IDX(i, _)                                      \
	{                                                                      \
		.flag = DT_PROP(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), flag),    \
		.offset = DT_PROP(NPCX_DT_PHANDLE_FROM_PSL_IN_NODE(i), offset),\
		.pinctrl = NPCX_DT_PSL_IN_ALT_CONF_BY_IDX(i)                   \
		.polarity = NPCX_DT_PSL_IN_POL_CONF_BY_IDX(i)                  \
	},

/**
 * @brief Macro function to construct a list of npcx_psl_in items by
 *        UTIL_LISTIFY func.
 *
 * Example devicetree fragment:
 *    / {
 *          vsby-psl-in-list {
 *              psl-in-pads = <&psl_in1>;
 *          };
 *	};
 *   &psl_in1 {
 *	flag = <NPCX_PSL_FALLING_EDGE>;
 *   };
 *
 * Example usage:
 * static const struct npcx_psl_in psl_in_confs[] = NPCX_DT_PSL_IN_ITEMS_LIST;
 *
 * @return an array of npcx_psl_in items which configures PSL input pads
 */
#define NPCX_DT_PSL_IN_ITEMS_LIST {                       \
		UTIL_LISTIFY(NPCX_DT_PSL_IN_ITEMS_LEN,    \
			NPCX_DT_PSL_IN_ITEMS_BY_IDX, _)   \
	}

/**
 * @brief Get base address of corresponding GPIO controller for enabling PSL
 *        output.
 *
 * @param @param inst number for devices with compatible 'nuvoton_npcx_psl_out'.
 * @return base address of corresponding GPIO controller
 */
#define NPCX_DT_PSL_OUT_CONTROLLER(inst) DT_REG_ADDR_BY_IDX(DT_PHANDLE_BY_IDX( \
		DT_INST(inst, nuvoton_npcx_psl_out), controller, 0), 0)

/**
 * @brief Get pin of corresponding GPIO controller for enabling PSL output.
 *
 * @param @param inst number for devices with compatible 'nuvoton_npcx_psl_out'.
 * @return pin of corresponding GPIO controller.
 */
#define NPCX_DT_PSL_OUT_PIN(inst) DT_PROP(DT_INST(inst, nuvoton_npcx_psl_out), \
							pin)

/**
 * @brief Check if the host interface type is automatically configured by
 * booter.
 *
 * @return TRUE - if the host interface is configured by booter,
 *         FALSE - otherwise.
 */
#define NPCX_BOOTER_IS_HIF_TYPE_SET() \
	DT_PROP(DT_PATH(booter_variant), hif_type_auto)

#endif /* _NUVOTON_NPCX_SOC_DT_H_ */