From: Will Deacon <will.deacon-5wv7dgnIgG8@public.gmane.org> To: Olav Haugan <ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> Cc: "linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org" <linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>, "iommu-cunTk1MwBs9QetFLy7KEm3xJsTq8ys+cHZ5vskTnxNA@public.gmane.org" <iommu-cunTk1MwBs9QetFLy7KEm3xJsTq8ys+cHZ5vskTnxNA@public.gmane.org>, "thierry.reding-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org" <thierry.reding-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>, Matt Wagantall <mattw-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org>, "vgandhi-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org" <vgandhi-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org>, "linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org" <linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org> Subject: Re: [RFC/PATCH 3/7] iopoll: Introduce memory-mapped IO polling macros Date: Tue, 1 Jul 2014 10:40:26 +0100 [thread overview] Message-ID: <20140701094026.GJ28164@arm.com> (raw) In-Reply-To: <1404147116-4598-4-git-send-email-ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> Hi Matt, On Mon, Jun 30, 2014 at 05:51:52PM +0100, Olav Haugan wrote: > From: Matt Wagantall <mattw-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> > > It is sometimes necessary to poll a memory-mapped register until its > value satisfies some condition. Introduce a family of convenience macros > that do this. Tight-loop and sleeping versions are provided with and > without timeouts. We could certainly use something like this in the SMMU and GICv3 drivers, so I agree that it makes sense for this to be in generic code. > +/** > + * readl_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @sleep_us: Maximum time to sleep between reads in uS (0 tight-loops) > + * @timeout_us: Timeout in uS, 0 means never timeout I think 0 should actually mean `use the default timeout', which could be something daft like 1s. Removing the timeout is asking for kernel lock-ups. We could also have a version without the timeout parameter at all, which acts like a timeout of 0. > + * > + * Returns 0 on success and -ETIMEDOUT upon a timeout. In either > + * case, the last read value at @addr is stored in @val. Must not > + * be called from atomic context if sleep_us or timeout_us are used. > + */ > +#define readl_poll_timeout(addr, val, cond, sleep_us, timeout_us) \ > +({ \ > + ktime_t timeout = ktime_add_us(ktime_get(), timeout_us); \ > + might_sleep_if(timeout_us); \ > + for (;;) { \ > + (val) = readl(addr); \ > + if (cond) \ > + break; \ > + if (timeout_us && ktime_compare(ktime_get(), timeout) > 0) { \ > + (val) = readl(addr); \ > + break; \ > + } \ > + if (sleep_us) \ > + usleep_range(DIV_ROUND_UP(sleep_us, 4), sleep_us); \ > + } \ > + (cond) ? 0 : -ETIMEDOUT; \ > +}) > + > +/** > + * readl_poll_timeout_noirq - Periodically poll an address until a condition is met or a timeout occurs > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @max_reads: Maximum number of reads before giving up I don't think max_reads is a useful tunable. > + * @time_between_us: Time to udelay() between successive reads > + * > + * Returns 0 on success and -ETIMEDOUT upon a timeout. > + */ > +#define readl_poll_timeout_noirq(addr, val, cond, max_reads, time_between_us) \ Maybe readl_poll_[timeout_]atomic is a better name? > +({ \ > + int count; \ > + for (count = (max_reads); count > 0; count--) { \ > + (val) = readl(addr); \ > + if (cond) \ > + break; \ > + udelay(time_between_us); \ > + } \ > + (cond) ? 0 : -ETIMEDOUT; \ > +}) > + > +/** > + * readl_poll - Periodically poll an address until a condition is met > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @sleep_us: Maximum time to sleep between reads in uS (0 tight-loops) > + * > + * Must not be called from atomic context if sleep_us is used. > + */ > +#define readl_poll(addr, val, cond, sleep_us) \ > + readl_poll_timeout(addr, val, cond, sleep_us, 0) Good idea ;) > +/** > + * readl_tight_poll_timeout - Tight-loop on an address until a condition is met or a timeout occurs > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @timeout_us: Timeout in uS, 0 means never timeout > + * > + * Returns 0 on success and -ETIMEDOUT upon a timeout. In either > + * case, the last read value at @addr is stored in @val. Must not > + * be called from atomic context if timeout_us is used. > + */ > +#define readl_tight_poll_timeout(addr, val, cond, timeout_us) \ > + readl_poll_timeout(addr, val, cond, 0, timeout_us) > + > +/** > + * readl_tight_poll - Tight-loop on an address until a condition is met > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * > + * May be called from atomic context. > + */ > +#define readl_tight_poll(addr, val, cond) \ > + readl_poll_timeout(addr, val, cond, 0, 0) This would be readl_poll_timeout_atomic if you went with my suggestion (i.e. readl_poll_timeout would have an unconditional might_sleep). What do you reckon? Will
WARNING: multiple messages have this Message-ID (diff)
From: will.deacon@arm.com (Will Deacon) To: linux-arm-kernel@lists.infradead.org Subject: [RFC/PATCH 3/7] iopoll: Introduce memory-mapped IO polling macros Date: Tue, 1 Jul 2014 10:40:26 +0100 [thread overview] Message-ID: <20140701094026.GJ28164@arm.com> (raw) In-Reply-To: <1404147116-4598-4-git-send-email-ohaugan@codeaurora.org> Hi Matt, On Mon, Jun 30, 2014 at 05:51:52PM +0100, Olav Haugan wrote: > From: Matt Wagantall <mattw@codeaurora.org> > > It is sometimes necessary to poll a memory-mapped register until its > value satisfies some condition. Introduce a family of convenience macros > that do this. Tight-loop and sleeping versions are provided with and > without timeouts. We could certainly use something like this in the SMMU and GICv3 drivers, so I agree that it makes sense for this to be in generic code. > +/** > + * readl_poll_timeout - Periodically poll an address until a condition is met or a timeout occurs > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @sleep_us: Maximum time to sleep between reads in uS (0 tight-loops) > + * @timeout_us: Timeout in uS, 0 means never timeout I think 0 should actually mean `use the default timeout', which could be something daft like 1s. Removing the timeout is asking for kernel lock-ups. We could also have a version without the timeout parameter at all, which acts like a timeout of 0. > + * > + * Returns 0 on success and -ETIMEDOUT upon a timeout. In either > + * case, the last read value at @addr is stored in @val. Must not > + * be called from atomic context if sleep_us or timeout_us are used. > + */ > +#define readl_poll_timeout(addr, val, cond, sleep_us, timeout_us) \ > +({ \ > + ktime_t timeout = ktime_add_us(ktime_get(), timeout_us); \ > + might_sleep_if(timeout_us); \ > + for (;;) { \ > + (val) = readl(addr); \ > + if (cond) \ > + break; \ > + if (timeout_us && ktime_compare(ktime_get(), timeout) > 0) { \ > + (val) = readl(addr); \ > + break; \ > + } \ > + if (sleep_us) \ > + usleep_range(DIV_ROUND_UP(sleep_us, 4), sleep_us); \ > + } \ > + (cond) ? 0 : -ETIMEDOUT; \ > +}) > + > +/** > + * readl_poll_timeout_noirq - Periodically poll an address until a condition is met or a timeout occurs > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @max_reads: Maximum number of reads before giving up I don't think max_reads is a useful tunable. > + * @time_between_us: Time to udelay() between successive reads > + * > + * Returns 0 on success and -ETIMEDOUT upon a timeout. > + */ > +#define readl_poll_timeout_noirq(addr, val, cond, max_reads, time_between_us) \ Maybe readl_poll_[timeout_]atomic is a better name? > +({ \ > + int count; \ > + for (count = (max_reads); count > 0; count--) { \ > + (val) = readl(addr); \ > + if (cond) \ > + break; \ > + udelay(time_between_us); \ > + } \ > + (cond) ? 0 : -ETIMEDOUT; \ > +}) > + > +/** > + * readl_poll - Periodically poll an address until a condition is met > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @sleep_us: Maximum time to sleep between reads in uS (0 tight-loops) > + * > + * Must not be called from atomic context if sleep_us is used. > + */ > +#define readl_poll(addr, val, cond, sleep_us) \ > + readl_poll_timeout(addr, val, cond, sleep_us, 0) Good idea ;) > +/** > + * readl_tight_poll_timeout - Tight-loop on an address until a condition is met or a timeout occurs > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * @timeout_us: Timeout in uS, 0 means never timeout > + * > + * Returns 0 on success and -ETIMEDOUT upon a timeout. In either > + * case, the last read value at @addr is stored in @val. Must not > + * be called from atomic context if timeout_us is used. > + */ > +#define readl_tight_poll_timeout(addr, val, cond, timeout_us) \ > + readl_poll_timeout(addr, val, cond, 0, timeout_us) > + > +/** > + * readl_tight_poll - Tight-loop on an address until a condition is met > + * @addr: Address to poll > + * @val: Variable to read the value into > + * @cond: Break condition (usually involving @val) > + * > + * May be called from atomic context. > + */ > +#define readl_tight_poll(addr, val, cond) \ > + readl_poll_timeout(addr, val, cond, 0, 0) This would be readl_poll_timeout_atomic if you went with my suggestion (i.e. readl_poll_timeout would have an unconditional might_sleep). What do you reckon? Will
next prev parent reply other threads:[~2014-07-01 9:40 UTC|newest] Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top 2014-06-30 16:51 [RFC/PATCH 0/7] Add MSM SMMUv1 support Olav Haugan 2014-06-30 16:51 ` Olav Haugan 2014-06-30 16:51 ` [RFC/PATCH 1/7] iommu: msm: Rename iommu driver files Olav Haugan 2014-06-30 16:51 ` Olav Haugan 2014-06-30 16:51 ` [RFC/PATCH 2/7] iommu-api: Add map_range/unmap_range functions Olav Haugan 2014-06-30 16:51 ` Olav Haugan 2014-06-30 19:42 ` Thierry Reding 2014-06-30 19:42 ` Thierry Reding 2014-07-01 9:33 ` Will Deacon 2014-07-01 9:33 ` Will Deacon 2014-07-01 9:58 ` Varun Sethi 2014-07-01 9:58 ` Varun Sethi 2014-07-04 4:29 ` Hiroshi Doyu 2014-07-04 4:29 ` Hiroshi Doyu 2014-07-08 21:53 ` Olav Haugan 2014-07-08 21:53 ` Olav Haugan 2014-07-08 23:49 ` Rob Clark 2014-07-08 23:49 ` Rob Clark 2014-07-10 0:03 ` Olav Haugan 2014-07-10 0:03 ` Olav Haugan [not found] ` <53BDD834.5030405-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> 2014-07-10 0:40 ` Rob Clark 2014-07-10 0:40 ` Rob Clark 2014-07-10 7:10 ` Thierry Reding 2014-07-10 7:10 ` Thierry Reding 2014-07-10 11:15 ` Rob Clark 2014-07-10 11:15 ` Rob Clark [not found] ` <CAF6AEGucNbo7sm9oQWFq9hcfoSeR5DuwRcRUvG+Y2sxLaM7OTQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org> 2014-07-10 22:43 ` Olav Haugan 2014-07-10 22:43 ` Olav Haugan 2014-07-10 23:42 ` Rob Clark 2014-07-10 23:42 ` Rob Clark 2014-07-11 10:20 ` Joerg Roedel 2014-07-11 10:20 ` Joerg Roedel [not found] ` <20140711102053.GB1958-zLv9SwRftAIdnm+yROfE0A@public.gmane.org> 2014-07-15 1:13 ` Olav Haugan 2014-07-15 1:13 ` Olav Haugan [not found] ` <1404147116-4598-1-git-send-email-ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> 2014-06-30 16:51 ` [RFC/PATCH 3/7] iopoll: Introduce memory-mapped IO polling macros Olav Haugan 2014-06-30 16:51 ` Olav Haugan [not found] ` <1404147116-4598-4-git-send-email-ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> 2014-06-30 19:46 ` Thierry Reding 2014-06-30 19:46 ` Thierry Reding 2014-07-01 9:40 ` Will Deacon [this message] 2014-07-01 9:40 ` Will Deacon 2014-06-30 16:51 ` [RFC/PATCH 4/7] iommu: msm: Add MSM IOMMUv1 driver Olav Haugan [not found] ` <1404147116-4598-5-git-send-email-ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> 2014-06-30 17:02 ` Will Deacon 2014-06-30 17:02 ` Will Deacon [not found] ` <20140630170221.GA30740-5wv7dgnIgG8@public.gmane.org> 2014-07-02 22:32 ` Olav Haugan 2014-07-02 22:32 ` Olav Haugan 2014-06-30 16:51 ` [RFC/PATCH 5/7] iommu: msm: Add support for V7L page table format Olav Haugan 2014-06-30 16:51 ` Olav Haugan 2014-06-30 16:51 ` [RFC/PATCH 6/7] defconfig: msm: Enable Qualcomm SMMUv1 driver Olav Haugan 2014-06-30 16:51 ` Olav Haugan 2014-06-30 16:51 ` [RFC/PATCH 7/7] iommu-api: Add domain attribute to enable coherent HTW Olav Haugan 2014-06-30 16:51 ` Olav Haugan [not found] ` <1404147116-4598-8-git-send-email-ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> 2014-07-01 8:49 ` Varun Sethi 2014-07-01 8:49 ` Varun Sethi 2014-07-02 22:11 ` Olav Haugan 2014-07-02 22:11 ` Olav Haugan [not found] ` <53B48381.9050707-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org> 2014-07-03 17:43 ` Will Deacon 2014-07-03 17:43 ` Will Deacon [not found] ` <20140703174321.GE17372-5wv7dgnIgG8@public.gmane.org> 2014-07-08 22:24 ` Olav Haugan 2014-07-08 22:24 ` Olav Haugan
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20140701094026.GJ28164@arm.com \ --to=will.deacon-5wv7dgnigg8@public.gmane.org \ --cc=iommu-cunTk1MwBs9QetFLy7KEm3xJsTq8ys+cHZ5vskTnxNA@public.gmane.org \ --cc=linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org \ --cc=linux-arm-msm-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \ --cc=mattw-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org \ --cc=ohaugan-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org \ --cc=thierry.reding-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \ --cc=vgandhi-sgV2jX0FEOL9JmXXK+q4OQ@public.gmane.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.