scmi_base.h

Go to the documentation of this file.

/*
 *  Copyright (C) 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 SCMI_BASE_H
#define SCMI_BASE_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <drivers/scp/scmi/v0/scmi.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t SCMI_baseGenericProtocolVersion(SCMI_Handle handle,
                                        SCMI_StandardProtocol protocolId,
                                        uint32_t *version);
 
int32_t SCMI_getBaseProtocolVersion(SCMI_Handle handle, uint32_t *version);
 
int32_t SCMI_baseGetProtocolAttributes(SCMI_Handle handle, uint32_t *numAgents,
                                       uint32_t *numProtocols);
 
int32_t SCMI_baseGetMessageAttributes(SCMI_Handle handle, uint32_t messageId,
                                      uint32_t *attributes);
 
int32_t SCMI_baseDiscoverVendor(SCMI_Handle handle, uint8_t *vendor);
 
int32_t SCMI_baseDiscoverSubVendor(SCMI_Handle handle,  uint8_t *subVendor);
 
int32_t SCMI_baseDiscoverImplementationVersion(SCMI_Handle handle,
                                               uint32_t *implVersion);
 
int32_t SCMI_baseDiscoverListProtocols(SCMI_Handle handle,
                                       uint32_t *protocolCount,
                                       uint8_t *protocols);
 
 
#endif /* SCMI_BASE_H */