device.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2018 Liviu Ionescu.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef CMSIS_PLUS_POSIX_IO_BLOCK_H_
#define CMSIS_PLUS_POSIX_IO_BLOCK_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#include <cmsis-plus/posix-io/io.h>
#include <cmsis-plus/utils/lists.h>
#include <mutex>
 
// ----------------------------------------------------------------------------
 
#if ! defined(OS_STRING_POSIX_DEVICE_PREFIX)
#define OS_STRING_POSIX_DEVICE_PREFIX "/dev/"
#endif
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
 
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wdocumentation-unknown-command"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace posix
  {
    // ------------------------------------------------------------------------
 
    class device_impl;
 
    // ========================================================================
 
    class device : public io
    {
      // ----------------------------------------------------------------------
 
    public:
 
      device (device_impl& impl, type t, const char* name);
 
      // The rule of five.
      device (const device&) = delete;
      device (device&&) = delete;
      device&
      operator= (const device&) = delete;
      device&
      operator= (device&&) = delete;
 
      virtual
      ~device () override;
 
      // ----------------------------------------------------------------------
    public:
 
      int
      open (const char* path = nullptr, int oflag = 0, ...);
 
      int
      vopen (const char* path, int oflag, std::va_list args);
 
      virtual int
      close (void) override;
 
      int
      ioctl (int request, ...);
 
      virtual int
      vioctl (int request, std::va_list args);
 
      virtual void
      sync (void);
 
      // ----------------------------------------------------------------------
 
      virtual bool
      match_name (const char* name) const;
 
      const char*
      name (void) const;
 
      static const char*
      device_prefix (void);
 
      // ----------------------------------------------------------------------
      // Support functions.
 
      device_impl&
      impl (void) const;
 
      // ----------------------------------------------------------------------
    protected:
 
      const char* name_ = nullptr;
 
      // ----------------------------------------------------------------------
    public:
 
      // Intrusive node used to link this device to the registry list.
      // Must be public.
      utils::double_list_links registry_links_;
 
    };
 
    // ========================================================================
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpadded"
 
    class device_impl : public io_impl
    {
      // ----------------------------------------------------------------------
 
      friend class device;
 
      // ----------------------------------------------------------------------
    public:
 
      device_impl (void);
 
      // The rule of five.
      device_impl (const device_impl&) = delete;
      device_impl (device_impl&&) = delete;
      device_impl&
      operator= (const device_impl&) = delete;
      device_impl&
      operator= (device_impl&&) = delete;
 
      virtual
      ~device_impl () override;
 
      // ----------------------------------------------------------------------
    public:
 
      virtual bool
      do_is_opened (void) override;
 
      virtual int
      do_vopen (const char* path, int oflag, std::va_list args) = 0;
 
      virtual int
      do_vioctl (int request, std::va_list args) = 0;
 
      virtual void
      do_sync (void) = 0;
 
      // ----------------------------------------------------------------------
 
      int
      open_count (void);
 
      // ----------------------------------------------------------------------
    protected:
 
      int open_count_ = 0;
 
    };
 
#pragma GCC diagnostic pop
 
  // ==========================================================================
  } /* namespace posix */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace posix
  {
    // ========================================================================
 
    inline const char*
    device::name (void) const
    {
      return name_;
    }
 
    inline device_impl&
    device::impl (void) const
    {
      return static_cast<device_impl&> (impl_);
    }
 
    inline const char*
    device::device_prefix (void)
    {
      return OS_STRING_POSIX_DEVICE_PREFIX;
    }
 
    // ========================================================================
 
    inline int
    device_impl::open_count (void)
    {
      return open_count_;
    }
 
  // ==========================================================================
  } /* namespace posix */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_POSIX_IO_BLOCK_H_ */