display_utils/
error.rs

1// Copyright 2022 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 fidl_fuchsia_hardware_display::ClientCompositionOp;
6use fidl_fuchsia_hardware_display_types::{ClientCompositionOpcode, ConfigResult};
7
8use futures::channel::mpsc;
9use thiserror::Error;
10
11use crate::controller::VsyncEvent;
12use crate::types::{DisplayId, LayerId};
13
14/// Library error type.
15#[derive(Error, Debug)]
16pub enum Error {
17    /// Error encountered while connecting to a display-coordinator device via devfs.
18    #[error("could not find a display-coordinator device")]
19    DeviceNotFound,
20
21    /// No displays were reported by the display driver when expected.
22    #[error("device did not enumerate initial displays")]
23    NoDisplays,
24
25    /// A request handling task (such as one that owns a FIDL event stream that can only be
26    /// started once) was already been initiated before.
27    #[error("a singleton task was already initiated")]
28    AlreadyRequested,
29
30    /// Error while allocating shared sysmem buffers.
31    #[error("sysmem buffer collection allocation failed, or invalid response from sysmem")]
32    BuffersNotAllocated,
33
34    /// Error while establishing a connection to sysmem.
35    #[error("error while setting up a sysmem connection")]
36    SysmemConnection,
37
38    /// Ran out of free client-assigned identifiers.
39    #[error("ran out of identifiers")]
40    IdsExhausted,
41
42    /// Path to the device is invalid (e.g. containing invalid
43    /// characters).
44    #[error("invalid device path")]
45    DevicePathInvalid,
46
47    /// Wrapper for errors from FIDL bindings.
48    #[error("FIDL error: {0}")]
49    FidlError(#[from] fidl::Error),
50
51    /// Wrapper for system file I/O errors.
52    #[error("OS I/O error: {0}")]
53    IoError(#[from] std::io::Error),
54
55    /// Wrapper for errors from zircon syscalls.
56    #[error("zircon error: {0}")]
57    ZxError(#[from] zx::Status),
58
59    /// Wrapper for errors from FIDL device connections.
60    #[error("Device connection error: {0}")]
61    DeviceConnectionError(anyhow::Error),
62
63    /// Wrapper for errors from fuchsia-fs.
64    #[error("filesystem error: {0}")]
65    FsError(#[from] fuchsia_fs::node::OpenError),
66
67    /// Wrapper for errors from fuchsia-fs watcher creation.
68    #[error("failed to create directory watcher: {0}")]
69    WatcherCreateError(#[from] fuchsia_fs::directory::WatcherCreateError),
70
71    /// Wrapper for errors from the fuchsia-fs watcher stream.
72    #[error("directory watcher stream produced error: {0}")]
73    WatcherStreamError(#[from] fuchsia_fs::directory::WatcherStreamError),
74
75    /// Error that occurred while notifying vsync event listeners over an in-process async channel.
76    #[error("failed to notify vsync: {0}")]
77    CouldNotSendVsyncEvent(#[from] mpsc::TrySendError<VsyncEvent>),
78
79    /// UTF-8 validation error.
80    #[error("invalid UTF-8 string")]
81    InvalidUtf8(#[from] std::str::Utf8Error),
82}
83
84/// Library Result type alias.
85pub type Result<T> = std::result::Result<T, Error>;
86
87/// An error generated by `fuchsia.hardware.display.Controller.CheckConfig`.
88#[derive(Debug, Error)]
89pub enum ConfigError {
90    /// Failure due to an invalid configuration.
91    #[error("invalid configuration - error_code: {error_code:#?}, actions: {actions:#?}")]
92    Invalid {
93        /// The reason for the failure.
94        error_code: ConfigResult,
95
96        /// Suggested actions that the client can take to resolve the failure.
97        actions: Vec<ClientCompositionAction>,
98    },
99
100    /// Failure due to a FIDL transport error.
101    #[error("FIDL channel error")]
102    Fidl(#[from] fidl::Error),
103}
104
105/// Represents a suggested client composition action generated by the driver.
106#[derive(Debug, Clone)]
107pub struct ClientCompositionAction {
108    /// The ID of the display that concerns the action.
109    pub display_id: DisplayId,
110
111    /// The ID of the layer that the action should be taken on.
112    pub layer_id: LayerId,
113
114    /// Description of the action.
115    pub opcode: ClientCompositionOpcode,
116}
117
118impl ConfigError {
119    /// Create an `Invalid` configuration error variant from FIDL output.
120    pub fn invalid(error_code: ConfigResult, actions: Vec<ClientCompositionOp>) -> ConfigError {
121        ConfigError::Invalid {
122            error_code,
123            actions: actions.into_iter().map(ClientCompositionAction::from).collect(),
124        }
125    }
126}
127
128impl From<ClientCompositionOp> for ClientCompositionAction {
129    fn from(src: ClientCompositionOp) -> Self {
130        Self {
131            display_id: src.display_id.into(),
132            layer_id: src.layer_id.into(),
133            opcode: src.opcode,
134        }
135    }
136}
display_utils/error.rs

display_utils/
error.rs
