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 | /**
* @file
* @brief PWMs Devicetree macro public API header file.
*/
/*
* Copyright (c) 2020, Linaro Ltd.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_DEVICETREE_PWMS_H_
#define ZEPHYR_INCLUDE_DEVICETREE_PWMS_H_
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup devicetree-pwms Devicetree PWMs API
* @ingroup devicetree
* @{
*/
/**
* @brief Get a label property from a pwms property at an index
*
* It's an error if the PWM controller node referenced by the phandle
* in node_id's pwms property at index "idx" has no label property.
*
* Example devicetree fragment:
*
* pwm1: pwm-controller@... {
* label = "PWM_1";
* };
*
* pwm2: pwm-controller@... {
* label = "PWM_2";
* };
*
* n: node {
* pwms = <&pwm1 1 PWM_POLARITY_NORMAL>,
* <&pwm2 3 PWM_POLARITY_INVERTED>;
* };
*
* Example usage:
*
* DT_PWMS_LABEL_BY_IDX(DT_NODELABEL(n), 0) // "PWM_1"
* DT_PWMS_LABEL_BY_IDX(DT_NODELABEL(n), 1) // "PWM_2"
*
* @param node_id node identifier for a node with a pwms property
* @param idx logical index into pwms property
* @return the label property of the node referenced at index "idx"
* @see DT_PROP_BY_PHANDLE_IDX()
*/
#define DT_PWMS_LABEL_BY_IDX(node_id, idx) \
DT_PROP_BY_PHANDLE_IDX(node_id, pwms, idx, label)
/**
* @brief Get a label property from a pwms property by name
*
* It's an error if the PWM controller node referenced by the
* phandle in node_id's pwms property at the element named "name"
* has no label property.
*
* Example devicetree fragment:
*
* pwm1: pwm-controller@... {
* label = "PWM_1";
* };
*
* pwm2: pwm-controller@... {
* label = "PWM_2";
* };
*
* n: node {
* pwms = <&pwm1 1 PWM_POLARITY_NORMAL>,
* <&pwm2 3 PWM_POLARITY_INVERTED>;
* pwm-names = "alpha", "beta";
* };
*
* Example usage:
*
* DT_PWMS_LABEL_BY_NAME(DT_NODELABEL(n), alpha) // "PWM_1"
* DT_PWMS_LABEL_BY_NAME(DT_NODELABEL(n), beta) // "PWM_2"
*
* @param node_id node identifier for a node with a pwms property
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the label property of the node referenced at the named element
* @see DT_PHANDLE_BY_NAME()
*/
#define DT_PWMS_LABEL_BY_NAME(node_id, name) \
DT_PROP(DT_PHANDLE_BY_NAME(node_id, pwms, name), label)
/**
* @brief Equivalent to DT_PWMS_LABEL_BY_IDX(node_id, 0)
* @param node_id node identifier for a node with a pwms property
* @return the label property of the node referenced at index 0
* @see DT_PWMS_LABEL_BY_IDX()
*/
#define DT_PWMS_LABEL(node_id) DT_PWMS_LABEL_BY_IDX(node_id, 0)
/**
* @brief Get PWM specifier's cell value at an index
*
* Example devicetree fragment:
*
* pwm1: pwm-controller@... {
* compatible = "vnd,pwm";
* label = "PWM_1";
* #pwm-cells = <2>;
* };
*
* pwm2: pwm-controller@... {
* compatible = "vnd,pwm";
* label = "PWM_2";
* #pwm-cells = <2>;
* };
*
* n: node {
* pwms = <&pwm1 1 200000 PWM_POLARITY_NORMAL>,
* <&pwm2 3 100000 PWM_POLARITY_INVERTED>;
* };
*
* Bindings fragment for the "vnd,pwm" compatible:
*
* pwm-cells:
* - channel
* - period
* - flags
*
* Example usage:
*
* DT_PWMS_CELL_BY_IDX(DT_NODELABEL(n), 0, channel) // 1
* DT_PWMS_CELL_BY_IDX(DT_NODELABEL(n), 1, channel) // 3
* DT_PWMS_CELL_BY_IDX(DT_NODELABEL(n), 0, period) // 200000
* DT_PWMS_CELL_BY_IDX(DT_NODELABEL(n), 1, period) // 100000
* DT_PWMS_CELL_BY_IDX(DT_NODELABEL(n), 0, flags) // PWM_POLARITY_NORMAL
* DT_PWMS_CELL_BY_IDX(DT_NODELABEL(n), 1, flags) // PWM_POLARITY_INVERTED
*
* @param node_id node identifier for a node with a pwms property
* @param idx logical index into pwms property
* @param cell lowercase-and-underscores cell name
* @return the cell value at index "idx"
* @see DT_PHA_BY_IDX()
*/
#define DT_PWMS_CELL_BY_IDX(node_id, idx, cell) \
DT_PHA_BY_IDX(node_id, pwms, idx, cell)
/**
* @brief Get a PWM specifier's cell value by name
*
* Example devicetree fragment:
*
* pwm1: pwm-controller@... {
* compatible = "vnd,pwm";
* label = "PWM_1";
* #pwm-cells = <2>;
* };
*
* pwm2: pwm-controller@... {
* compatible = "vnd,pwm";
* label = "PWM_2";
* #pwm-cells = <2>;
* };
*
* n: node {
* pwms = <&pwm1 1 200000 PWM_POLARITY_NORMAL>,
* <&pwm2 3 100000 PWM_POLARITY_INVERTED>;
* pwm-names = "alpha", "beta";
* };
*
* Bindings fragment for the "vnd,pwm" compatible:
*
* pwm-cells:
* - channel
* - period
* - flags
*
* Example usage:
*
* DT_PWMS_CELL_BY_NAME(DT_NODELABEL(n), alpha, channel) // 1
* DT_PWMS_CELL_BY_NAME(DT_NODELABEL(n), beta, channel) // 3
* DT_PWMS_CELL_BY_NAME(DT_NODELABEL(n), alpha, period) // 200000
* DT_PWMS_CELL_BY_NAME(DT_NODELABEL(n), beta, period) // 100000
* DT_PWMS_CELL_BY_NAME(DT_NODELABEL(n), alpha, flags) // PWM_POLARITY_NORMAL
* DT_PWMS_CELL_BY_NAME(DT_NODELABEL(n), beta, flags) // PWM_POLARITY_INVERTED
*
* @param node_id node identifier for a node with a pwms property
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @param cell lowercase-and-underscores cell name
* @return the cell value in the specifier at the named element
* @see DT_PHA_BY_NAME()
*/
#define DT_PWMS_CELL_BY_NAME(node_id, name, cell) \
DT_PHA_BY_NAME(node_id, pwms, name, cell)
/**
* @brief Equivalent to DT_PWMS_CELL_BY_IDX(node_id, 0, cell)
* @param node_id node identifier for a node with a pwms property
* @param cell lowercase-and-underscores cell name
* @return the cell value at index 0
* @see DT_PWMS_CELL_BY_IDX()
*/
#define DT_PWMS_CELL(node_id, cell) DT_PWMS_CELL_BY_IDX(node_id, 0, cell)
/**
* @brief Get a PWM specifier's channel cell value at an index
*
* This macro only works for PWM specifiers with cells named "channel".
* Refer to the node's binding to check if necessary.
*
* This is equivalent to DT_PWMS_CELL_BY_IDX(node_id, idx, channel).
*
* @param node_id node identifier for a node with a pwms property
* @param idx logical index into pwms property
* @return the channel cell value at index "idx"
* @see DT_PWMS_CELL_BY_IDX()
*/
#define DT_PWMS_CHANNEL_BY_IDX(node_id, idx) \
DT_PWMS_CELL_BY_IDX(node_id, idx, channel)
/**
* @brief Get a PWM specifier's channel cell value by name
*
* This macro only works for PWM specifiers with cells named "channel".
* Refer to the node's binding to check if necessary.
*
* This is equivalent to DT_PWMS_CELL_BY_NAME(node_id, name, channel).
*
* @param node_id node identifier for a node with a pwms property
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the channel cell value in the specifier at the named element
* @see DT_PWMS_CELL_BY_NAME()
*/
#define DT_PWMS_CHANNEL_BY_NAME(node_id, name) \
DT_PWMS_CELL_BY_NAME(node_id, name, channel)
/**
* @brief Equivalent to DT_PWMS_CHANNEL_BY_IDX(node_id, 0)
* @param node_id node identifier for a node with a pwms property
* @return the channel cell value at index 0
* @see DT_PWMS_CHANNEL_BY_IDX()
*/
#define DT_PWMS_CHANNEL(node_id) DT_PWMS_CHANNEL_BY_IDX(node_id, 0)
/**
* @brief Get PWM specifier's period cell value at an index
*
* This macro only works for PWM specifiers with cells named "period".
* Refer to the node's binding to check if necessary.
*
* This is equivalent to DT_PWMS_CELL_BY_IDX(node_id, idx, period).
*
* @param node_id node identifier for a node with a pwms property
* @param idx logical index into pwms property
* @return the period cell value at index "idx"
* @see DT_PWMS_CELL_BY_IDX()
*/
#define DT_PWMS_PERIOD_BY_IDX(node_id, idx) \
DT_PWMS_CELL_BY_IDX(node_id, idx, period)
/**
* @brief Get a PWM specifier's period cell value by name
*
* This macro only works for PWM specifiers with cells named "period".
* Refer to the node's binding to check if necessary.
*
* This is equivalent to DT_PWMS_CELL_BY_NAME(node_id, name, period).
*
* @param node_id node identifier for a node with a pwms property
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the period cell value in the specifier at the named element
* @see DT_PWMS_CELL_BY_NAME()
*/
#define DT_PWMS_PERIOD_BY_NAME(node_id, name) \
DT_PWMS_CELL_BY_NAME(node_id, name, period)
/**
* @brief Equivalent to DT_PWMS_PERIOD_BY_IDX(node_id, 0)
* @param node_id node identifier for a node with a pwms property
* @return the period cell value at index 0
* @see DT_PWMS_PERIOD_BY_IDX()
*/
#define DT_PWMS_PERIOD(node_id) DT_PWMS_PERIOD_BY_IDX(node_id, 0)
/**
* @brief Get a PWM specifier's flags cell value at an index
*
* This macro expects PWM specifiers with cells named "flags".
* If there is no "flags" cell in the PWM specifier, zero is returned.
* Refer to the node's binding to check specifier cell names if necessary.
*
* This is equivalent to DT_PWMS_CELL_BY_IDX(node_id, idx, flags).
*
* @param node_id node identifier for a node with a pwms property
* @param idx logical index into pwms property
* @return the flags cell value at index "idx", or zero if there is none
* @see DT_PWMS_CELL_BY_IDX()
*/
#define DT_PWMS_FLAGS_BY_IDX(node_id, idx) \
DT_PHA_BY_IDX_OR(node_id, pwms, idx, flags, 0)
/**
* @brief Get a PWM specifier's flags cell value by name
*
* This macro expects PWM specifiers with cells named "flags".
* If there is no "flags" cell in the PWM specifier, zero is returned.
* Refer to the node's binding to check specifier cell names if necessary.
*
* This is equivalent to DT_PWMS_CELL_BY_NAME(node_id, name, flags) if
* there is a flags cell, but expands to zero if there is none.
*
* @param node_id node identifier for a node with a pwms property
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the flags cell value in the specifier at the named element,
* or zero if there is none
* @see DT_PWMS_CELL_BY_NAME()
*/
#define DT_PWMS_FLAGS_BY_NAME(node_id, name) \
DT_PHA_BY_NAME_OR(node_id, pwms, name, flags, 0)
/**
* @brief Equivalent to DT_PWMS_FLAGS_BY_IDX(node_id, 0)
* @param node_id node identifier for a node with a pwms property
* @return the flags cell value at index 0, or zero if there is none
* @see DT_PWMS_FLAGS_BY_IDX()
*/
#define DT_PWMS_FLAGS(node_id) DT_PWMS_FLAGS_BY_IDX(node_id, 0)
/**
* @brief Get a label property from a DT_DRV_COMPAT instance's pwms
* property by name
* @param inst DT_DRV_COMPAT instance number
* @param idx logical index into pwms property
* @return the label property of the node referenced at index "idx"
* @see DT_PWMS_LABEL_BY_IDX()
*/
#define DT_INST_PWMS_LABEL_BY_IDX(inst, idx) \
DT_PWMS_LABEL_BY_IDX(DT_DRV_INST(inst), idx)
/**
* @brief Get a label property from a DT_DRV_COMPAT instance's pwms
* property by name
* @param inst DT_DRV_COMPAT instance number
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the label property of the node referenced at the named element
* @see DT_PWMS_LABEL_BY_NAME()
*/
#define DT_INST_PWMS_LABEL_BY_NAME(inst, name) \
DT_PWMS_LABEL_BY_NAME(DT_DRV_INST(inst), name)
/**
* @brief Equivalent to DT_INST_PWMS_LABEL_BY_IDX(inst, 0)
* @param inst DT_DRV_COMPAT instance number
* @return the label property of the node referenced at index 0
* @see DT_PWMS_LABEL_BY_IDX()
*/
#define DT_INST_PWMS_LABEL(inst) DT_INST_PWMS_LABEL_BY_IDX(inst, 0)
/**
* @brief Get a DT_DRV_COMPAT instance's PWM specifier's cell value
* at an index
* @param inst DT_DRV_COMPAT instance number
* @param idx logical index into pwms property
* @param cell lowercase-and-underscores cell name
* @return the cell value at index "idx"
*/
#define DT_INST_PWMS_CELL_BY_IDX(inst, idx, cell) \
DT_PWMS_CELL_BY_IDX(DT_DRV_INST(inst), idx, cell)
/**
* @brief Get a DT_DRV_COMPAT instance's PWM specifier's cell value by name
* @param inst DT_DRV_COMPAT instance number
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @param cell lowercase-and-underscores cell name
* @return the cell value in the specifier at the named element
* @see DT_PWMS_CELL_BY_NAME()
*/
#define DT_INST_PWMS_CELL_BY_NAME(inst, name, cell) \
DT_PWMS_CELL_BY_NAME(DT_DRV_INST(inst), name, cell)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_IDX(inst, 0, cell)
* @param inst DT_DRV_COMPAT instance number
* @param cell lowercase-and-underscores cell name
* @return the cell value at index 0
*/
#define DT_INST_PWMS_CELL(inst, cell) \
DT_INST_PWMS_CELL_BY_IDX(inst, 0, cell)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_IDX(inst, idx, channel)
* @param inst DT_DRV_COMPAT instance number
* @param idx logical index into pwms property
* @return the channel cell value at index "idx"
* @see DT_INST_PWMS_CELL_BY_IDX()
*/
#define DT_INST_PWMS_CHANNEL_BY_IDX(inst, idx) \
DT_INST_PWMS_CELL_BY_IDX(inst, idx, channel)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_NAME(inst, name, channel)
* @param inst DT_DRV_COMPAT instance number
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the channel cell value in the specifier at the named element
* @see DT_INST_PWMS_CELL_BY_NAME()
*/
#define DT_INST_PWMS_CHANNEL_BY_NAME(inst, name) \
DT_INST_PWMS_CELL_BY_NAME(inst, name, channel)
/**
* @brief Equivalent to DT_INST_PWMS_CHANNEL_BY_IDX(inst, 0)
* @param inst DT_DRV_COMPAT instance number
* @return the channel cell value at index 0
* @see DT_INST_PWMS_CHANNEL_BY_IDX()
*/
#define DT_INST_PWMS_CHANNEL(inst) DT_INST_PWMS_CHANNEL_BY_IDX(inst, 0)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_IDX(inst, idx, period)
* @param inst DT_DRV_COMPAT instance number
* @param idx logical index into pwms property
* @return the period cell value at index "idx"
* @see DT_INST_PWMS_CELL_BY_IDX()
*/
#define DT_INST_PWMS_PERIOD_BY_IDX(inst, idx) \
DT_INST_PWMS_CELL_BY_IDX(inst, idx, period)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_NAME(inst, name, period)
* @param inst DT_DRV_COMPAT instance number
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the period cell value in the specifier at the named element
* @see DT_INST_PWMS_CELL_BY_NAME()
*/
#define DT_INST_PWMS_PERIOD_BY_NAME(inst, name) \
DT_INST_PWMS_CELL_BY_NAME(inst, name, period)
/**
* @brief Equivalent to DT_INST_PWMS_PERIOD_BY_IDX(inst, 0)
* @param inst DT_DRV_COMPAT instance number
* @return the period cell value at index 0
* @see DT_INST_PWMS_PERIOD_BY_IDX()
*/
#define DT_INST_PWMS_PERIOD(inst) DT_INST_PWMS_PERIOD_BY_IDX(inst, 0)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_IDX(inst, idx, flags)
* @param inst DT_DRV_COMPAT instance number
* @param idx logical index into pwms property
* @return the flags cell value at index "idx", or zero if there is none
* @see DT_INST_PWMS_CELL_BY_IDX()
*/
#define DT_INST_PWMS_FLAGS_BY_IDX(inst, idx) \
DT_INST_PWMS_CELL_BY_IDX(inst, idx, flags)
/**
* @brief Equivalent to DT_INST_PWMS_CELL_BY_NAME(inst, name, flags)
* @param inst DT_DRV_COMPAT instance number
* @param name lowercase-and-underscores name of a pwms element
* as defined by the node's pwm-names property
* @return the flags cell value in the specifier at the named element,
* or zero if there is none
* @see DT_INST_PWMS_CELL_BY_NAME()
*/
#define DT_INST_PWMS_FLAGS_BY_NAME(inst, name) \
DT_INST_PWMS_CELL_BY_NAME(inst, name, flags)
/**
* @brief Equivalent to DT_INST_PWMS_FLAGS_BY_IDX(inst, 0)
* @param inst DT_DRV_COMPAT instance number
* @return the flags cell value at index 0, or zero if there is none
* @see DT_INST_PWMS_FLAGS_BY_IDX()
*/
#define DT_INST_PWMS_FLAGS(inst) DT_INST_PWMS_FLAGS_BY_IDX(inst, 0)
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* ZEPHYR_INCLUDE_DEVICETREE_PWMS_H_ */
|