builtins/
mmio_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::{format_err, Error};
6use fidl_fuchsia_kernel as fkernel;
7use futures::prelude::*;
8use std::sync::Arc;
9use zx::{self as zx, HandleBased, Resource};
10
11/// An implementation of fuchsia.kernel.MmioResource protocol.
12pub struct MmioResource {
13    resource: Resource,
14}
15
16impl MmioResource {
17    /// `resource` must be the MMIO 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::MmioResourceRequestStream,
25    ) -> Result<(), Error> {
26        if self.resource.info()?.kind != zx::sys::ZX_RSRC_KIND_MMIO {
27            return Err(format_err!("invalid handle kind, expected MMIO"));
28        }
29        while let Some(fkernel::MmioResourceRequest::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 fuchsia_component::client::connect_to_protocol;
40    use {fidl_fuchsia_kernel as fkernel, fuchsia_async as fasync};
41
42    async fn get_mmio_resource() -> Result<Resource, Error> {
43        let mmio_resource_provider = connect_to_protocol::<fkernel::MmioResourceMarker>()?;
44        let mmio_resource_handle = mmio_resource_provider.get().await?;
45        Ok(Resource::from(mmio_resource_handle))
46    }
47
48    async fn serve_mmio_resource() -> Result<fkernel::MmioResourceProxy, Error> {
49        let mmio_resource = get_mmio_resource().await?;
50
51        let (proxy, stream) =
52            fidl::endpoints::create_proxy_and_stream::<fkernel::MmioResourceMarker>();
53        fasync::Task::local(
54            MmioResource::new(mmio_resource)
55                .serve(stream)
56                .unwrap_or_else(|e| panic!("Error while serving MMIO resource service: {}", e)),
57        )
58        .detach();
59        Ok(proxy)
60    }
61
62    #[fuchsia::test]
63    async fn kind_type_is_mmio() -> Result<(), Error> {
64        let mmio_resource_provider = serve_mmio_resource().await?;
65        let mmio_resource: Resource = mmio_resource_provider.get().await?;
66        let resource_info = mmio_resource.info()?;
67        assert_eq!(resource_info.kind, zx::sys::ZX_RSRC_KIND_MMIO);
68        assert_eq!(resource_info.base, 0);
69        assert_eq!(resource_info.size, 0);
70        Ok(())
71    }
72}