tisci_pm_clock.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2015-2025 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    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.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  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 TISCI_PM_TISCI_CLOCK_H
#define TISCI_PM_TISCI_CLOCK_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
 
#define TISCI_MSG_VALUE_CLOCK_SW_STATE_UNREQ        0
 
#define TISCI_MSG_VALUE_CLOCK_SW_STATE_AUTO         1
 
#define TISCI_MSG_VALUE_CLOCK_SW_STATE_REQ          2
 
#define TISCI_MSG_VALUE_CLOCK_HW_STATE_NOT_READY    0
 
#define TISCI_MSG_VALUE_CLOCK_HW_STATE_READY        1
 
#define TISCI_MSG_VALUE_CLOCK_SSC_SPREAD_DOWN       3U
 
#define TISCI_MSG_VALUE_CLOCK_SSC_SPREAD_CENTER     1U
 
#define TISCI_MSG_FLAG_CLOCK_ALLOW_FREQ_CHANGE        TISCI_BIT(9)
 
#define TISCI_MSG_FLAG_CLOCK_INPUT_TERM               TISCI_BIT(10)
 
#define TISCI_MSG_FLAG_CLOCK_SSC_ACTIVE               TISCI_BIT(11)
 
struct tisci_msg_set_clock_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint8_t            clk;
    uint8_t            state;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_set_clock_resp {
    struct tisci_header hdr;
} __attribute__((__packed__));
 
struct tisci_msg_get_clock_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint8_t            clk;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_get_clock_resp {
    struct tisci_header    hdr;
    uint8_t            programmed_state;
    uint8_t            current_state;
} __attribute__((__packed__));
 
struct tisci_msg_set_clock_parent_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint8_t            clk;
    uint8_t            parent;
    uint32_t            clk32;
    uint32_t            parent32;
} __attribute__((__packed__));
 
struct tisci_msg_set_clock_parent_resp {
    struct tisci_header hdr;
} __attribute__((__packed__));
 
struct tisci_msg_get_clock_parent_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint8_t            clk;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_get_clock_parent_resp {
    struct tisci_header    hdr;
    uint8_t            parent;
    uint32_t            parent32;
} __attribute__((__packed__));
 
struct tisci_msg_get_num_clock_parents_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint8_t            clk;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_get_num_clock_parents_resp {
    struct tisci_header    hdr;
    uint8_t            num_parents;
    uint32_t            num_parentint32_t;
} __attribute__((__packed__));
 
struct tisci_msg_set_freq_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint64_t            min_freq_hz;
    uint64_t            target_freq_hz;
    uint64_t            max_freq_hz;
    uint8_t            clk;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_set_freq_resp {
    struct tisci_header hdr;
} __attribute__((__packed__));
 
struct tisci_msg_query_freq_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint64_t            min_freq_hz;
    uint64_t            target_freq_hz;
    uint64_t            max_freq_hz;
    uint8_t            clk;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_query_freq_resp {
    struct tisci_header    hdr;
    uint64_t            freq_hz;
} __attribute__((__packed__));
 
struct tisci_msg_get_freq_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint8_t            clk;
    uint32_t            clk32;
} __attribute__((__packed__));
 
struct tisci_msg_get_freq_resp {
    struct tisci_header    hdr;
    uint64_t            freq_hz;
} __attribute__((__packed__));
 
struct tisci_msg_set_clock_ssc_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint32_t            clk;
    uint32_t            modfreq_hz;
    uint32_t            mod_depth;
    uint8_t            spread_type;
    uint8_t            enable;
} __attribute__((__packed__));
 
struct tisci_msg_set_clock_ssc_resp {
    struct tisci_header hdr;
} __attribute__((__packed__));
 
struct tisci_msg_get_clock_ssc_req {
    struct tisci_header    hdr;
    uint32_t            device;
    uint32_t            clk;
} __attribute__((__packed__));
 
struct tisci_msg_get_clock_ssc_resp {
    struct tisci_header    hdr;
    uint32_t            modfreq_hz;
    uint32_t            mod_depth;
    uint8_t            spread_type;
    uint8_t            enable;
} __attribute__((__packed__));
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* TISCI_PM_TISCI_CLOCK_H */