power.h

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (c) 2016 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef LIBBSP_ARM_ATSAM_POWER_H
#define LIBBSP_ARM_ATSAM_POWER_H
 
#include <sys/types.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"{
#endif /* __cplusplus */
 
typedef enum {
  ATSAM_POWER_INIT,
  ATSAM_POWER_ON,
  ATSAM_POWER_OFF
} atsam_power_state;
 
typedef struct atsam_power_control {
  void (*handler)(
      const struct atsam_power_control *control,
      atsam_power_state state
  );
  union {
    void *arg;
    struct {
      uint8_t first;
      uint8_t last;
    } peripherals;
  } data;
} atsam_power_control;
 
void atsam_power_change_state(
  const atsam_power_control *controls,
  size_t n,
  atsam_power_state state
);
 
void atsam_power_handler_peripheral(
  const atsam_power_control *controls,
  atsam_power_state state
);
 
void atsam_power_handler_clock_driver(
  const atsam_power_control *controls,
  atsam_power_state state
);
 
void atsam_power_handler_rtc_driver(
  const atsam_power_control *controls,
  atsam_power_state state
);
 
void atsam_power_handler_sleep_mode(
  const atsam_power_control *controls,
  atsam_power_state state
);
 
void atsam_power_handler_wait_mode(
  const atsam_power_control *controls,
  atsam_power_state state
);
 
#define ATSAM_POWER_PERIPHERAL(f, l) \
 { \
   .handler = atsam_power_handler_peripheral, \
   .data = { .peripherals = { .first = f, .last = l } } \
 }
 
#define ATSAM_POWER_HANDLER(h, a) \
 { \
   .handler = h, \
   .data = { .arg = a } \
 }
 
#define ATSAM_POWER_CLOCK_DRIVER \
 { .handler = atsam_power_handler_clock_driver }
 
#define ATSAM_POWER_SLEEP_MODE \
 { .handler = atsam_power_handler_sleep_mode }
 
#define ATSAM_POWER_WAIT_MODE \
 { .handler = atsam_power_handler_wait_mode }
 
typedef struct {
  uint32_t interval;
} atsam_power_data_rtc_driver;
 
#define ATSAM_POWER_RTC_DRIVER(a) \
 { \
    .handler = atsam_power_handler_rtc_driver, \
    .data = { .arg = a } \
 }
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* LIBBSP_ARM_ATSAM_POWER_H */