xref: /openbmc/linux/scripts/atomic/kerneldoc/dec_if_positive (revision 2612e3bbc0386368a850140a6c9b990cd496a5ec)
1ad811070SMark Rutlandcat <<EOF
2ad811070SMark Rutland/**
3ad811070SMark Rutland * ${class}${atomicname}() - atomic decrement if positive with ${desc_order} ordering
4ad811070SMark Rutland * @v: pointer to ${atomic}_t
5ad811070SMark Rutland *
6ad811070SMark Rutland * If (@v > 0), atomically updates @v to (@v - 1) with ${desc_order} ordering.
7ad811070SMark Rutland *
8ad811070SMark Rutland * ${desc_noinstr}
9ad811070SMark Rutland *
10*b33eb50aSMark Rutland * Return: The old value of (@v - 1), regardless of whether @v was updated.
11ad811070SMark Rutland */
12ad811070SMark RutlandEOF
13