Skip to main content

builtins/
irq_resource.rs

1// Copyright 2020 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use anyhow::{Error, format_err};
6use fidl_fuchsia_kernel as fkernel;
7use futures::prelude::*;
8use std::sync::Arc;
9use zx::Resource;
10
11/// An implementation of fuchsia.kernel.IrqResource protocol.
12pub struct IrqResource {
13    resource: Resource,
14}
15
16impl IrqResource {
17    /// `resource` must be the IRQ resource.
18    pub fn new(resource: Resource) -> Arc<Self> {
19        Arc::new(Self { resource })
20    }
21
22    pub async fn serve(
23        self: Arc<Self>,
24        mut stream: fkernel::IrqResourceRequestStream,
25    ) -> Result<(), Error> {
26        if self.resource.info()?.kind != zx::sys::ZX_RSRC_KIND_IRQ {
27            return Err(format_err!("invalid handle kind, expected IRQ"));
28        }
29        while let Some(fkernel::IrqResourceRequest::Get { responder }) = stream.try_next().await? {
30            responder.send(self.resource.duplicate_handle(zx::Rights::SAME_RIGHTS)?)?;
31        }
32        Ok(())
33    }
34}
35
36#[cfg(test)]
37mod tests {
38    use super::*;
39    use fidl_fuchsia_kernel as fkernel;
40    use fuchsia_async as fasync;
41    use fuchsia_component::client::connect_to_protocol;
42
43    async fn get_irq_resource() -> Result<Resource, Error> {
44        let irq_resource_provider = connect_to_protocol::<fkernel::IrqResourceMarker>()?;
45        let irq_resource_handle = irq_resource_provider.get().await?;
46        Ok(Resource::from(irq_resource_handle))
47    }
48
49    async fn serve_irq_resource() -> Result<fkernel::IrqResourceProxy, Error> {
50        let irq_resource = get_irq_resource().await?;
51
52        let (proxy, stream) =
53            fidl::endpoints::create_proxy_and_stream::<fkernel::IrqResourceMarker>();
54        fasync::Task::local(
55            IrqResource::new(irq_resource)
56                .serve(stream)
57                .unwrap_or_else(|e| panic!("Error while serving IRQ resource service: {}", e)),
58        )
59        .detach();
60        Ok(proxy)
61    }
62
63    #[fuchsia::test]
64    async fn fail_with_no_irq_resource() -> Result<(), Error> {
65        let (_, stream) = fidl::endpoints::create_proxy_and_stream::<fkernel::IrqResourceMarker>();
66        IrqResource::new(Resource::from(zx::NullableHandle::invalid()))
67            .serve(stream)
68            .await
69            .expect_err("should fail to serve stream with an invalid resource");
70        Ok(())
71    }
72
73    #[fuchsia::test]
74    async fn kind_type_is_irq() -> Result<(), Error> {
75        let irq_resource_provider = serve_irq_resource().await?;
76        let irq_resource: Resource = irq_resource_provider.get().await?;
77        let resource_info = irq_resource.info()?;
78        assert_eq!(resource_info.kind, zx::sys::ZX_RSRC_KIND_IRQ);
79        assert_eq!(resource_info.base, 0);
80        assert_eq!(resource_info.size, 0);
81        Ok(())
82    }
83}