tisci_boardcfg_rm.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2017-2024 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_BOARD_CFG_RM_H
#define TISCI_BOARD_CFG_RM_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
 
#define TISCI_BOARDCFG_RM_HOST_CFG_MAGIC_NUM          (0x4C41U)
#define TISCI_BOARDCFG_RM_RESASG_MAGIC_NUM            (0x7B25U)
 
#define TISCI_BOARDCFG_RM_ABI_MAJ_VALUE               (0x00)
#define TISCI_BOARDCFG_RM_ABI_MIN_VALUE               (0x01)
 
struct tisci_boardcfg_substructure_rm_header {
    uint16_t    magic;
    uint16_t    size;
} __attribute__((__packed__));
 
struct tisci_boardcfg_abi_rm_rev {
    uint8_t    tisci_boardcfg_abi_maj;
    uint8_t    tisci_boardcfg_abi_min;
} __attribute__((__packed__));
 
struct tisci_boardcfg_rm_host_cfg_entry {
    uint8_t    host_id;
    uint8_t    allowed_atype;
    uint16_t    allowed_qos;
    uint32_t    allowed_orderid;
    uint16_t    allowed_priority;
    uint8_t    allowed_sched_priority;
} __attribute__((__packed__));
 
/* \brief How many host configuration list entries */
#define TISCI_BOARDCFG_RM_HOST_CFG_ENTRIES (32U)
 
struct tisci_boardcfg_rm_host_cfg {
    struct tisci_boardcfg_substructure_rm_header    subhdr;
    struct tisci_boardcfg_rm_host_cfg_entry    host_cfg_entries[
        TISCI_BOARDCFG_RM_HOST_CFG_ENTRIES];
};
 
struct tisci_boardcfg_rm_resasg_entry {
    uint16_t    start_resource;
    uint16_t    num_resource;
    uint16_t    type;
    uint8_t    host_id;
    uint8_t    reserved;
};
 
struct tisci_boardcfg_rm_resasg {
    struct tisci_boardcfg_substructure_rm_header    subhdr;
    uint16_t                    resasg_entries_size;
    uint16_t                    reserved;
} __attribute__((__packed__));
 
struct tisci_boardcfg_rm {
    struct tisci_boardcfg_abi_rm_rev    rev;
    struct tisci_boardcfg_rm_host_cfg    host_cfg;
    struct tisci_boardcfg_rm_resasg    resasg;
} __attribute__((__packed__));
 
const struct tisci_boardcfg_rm_host_cfg *tisci_boardcfg_get_rm_host_cfg(void);
 
uint16_t tisci_boardcfg_get_rm_resasg_size(void);
 
const struct tisci_boardcfg_rm_resasg_entry *tisci_boardcfg_get_rm_resasg(void);
 
int32_t tisci_boardcfg_get_rm_devgrp(devgrp_t *devgrp);
 
 
#ifdef __cplusplus
}
#endif
 
#endif          /* TISCI_BOARD_CFG_RM_H */