Skip to content

doc: new platform_api group to be referred by sof-docs #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 1 commit into from
Jul 5, 2018
Merged

doc: new platform_api group to be referred by sof-docs #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/include/sof/platform.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,22 @@
* Author: Marcin Maka <marcin.maka@linux.intel.com>
*/

/**
* \file include/sof/platform.h
* \brief Platform API definition
* \author Marcin Maka <marcin.maka@linux.intel.com>
*/

#ifndef __INCLUDE_SOF_PLATFORM_H__
#define __INCLUDE_SOF_PLATFORM_H__

#include <sof/sof.h>

/** \addtogroup platform_api Platform API
* Platform API specification.
* @{
*/

/*
* APIs declared here are defined for every platform.
*/
Expand All @@ -53,8 +64,10 @@ int platform_init(struct sof *sof);

/**
* \brief Called by the panic handler.
* \param[in] p Panic cause, one of SOF_IPC_PANIC_... codes.
* \param[in] p Panic cause, one of SOF_IPC_PANIC_... codes (see ipc.h).
*/
static inline void platform_panic(uint32_t p);

/** @}*/

#endif