diff options
author | Jonathan Aillet <jonathan.aillet@iot.bzh> | 2019-04-18 12:40:25 +0200 |
---|---|---|
committer | Jonathan Aillet <jonathan.aillet@iot.bzh> | 2019-05-24 12:05:52 +0200 |
commit | 68138a3ec7a78ad7304d291ff92d8e5292847c4e (patch) | |
tree | 9157134d50a749c838afdf93a49c4ce17a018347 /4a-hal-utilities/4a-hal-utilities-data.h | |
parent | 196e723e79a1f5eae41cf4a8b1450df0679a4af8 (diff) |
Clarify internals hal functions and files names
The purpose of this commit is to have of a more standard way to
name files and functions used to generate/handle hal api
(generated from hal json configuration file).
It occurred to me that 'hal-controller' was not a good name
because it is harder for people who don't know about
the app-controller to understanded what is the purpose of
these files/functions.
It was renamed to 'internal-hal' because it's about hal
that are all handle/load by hal-manager in opposition of
external-hal that are independant binding/binder that can register
themselves to hal-manager.
BUG-AGL: SPEC-2329
Change-Id: I11b7efe64ec474b004a2a15ed8969b9db95d428f
Signed-off-by: Jonathan Aillet <jonathan.aillet@iot.bzh>
Diffstat (limited to '4a-hal-utilities/4a-hal-utilities-data.h')
-rw-r--r-- | 4a-hal-utilities/4a-hal-utilities-data.h | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/4a-hal-utilities/4a-hal-utilities-data.h b/4a-hal-utilities/4a-hal-utilities-data.h index 1389aa6..f3de1a6 100644 --- a/4a-hal-utilities/4a-hal-utilities-data.h +++ b/4a-hal-utilities/4a-hal-utilities-data.h @@ -30,7 +30,7 @@ #define HAL_STREAM_UPDATES_EVENT_NAME "stream-updates" -// Enum for sharing hal (controller or external) status +// Enum for hal status enum HalStatus { HAL_STATUS_UNAVAILABLE=0, HAL_STATUS_AVAILABLE=1, @@ -38,35 +38,35 @@ enum HalStatus { }; // Structure to store stream data -struct CtlHalMixerData { +struct InternalHalMixerData { char *verb; char *verbToCall; char *streamCardId; afb_event_t event; - struct CtlHalMixerData *next; + struct InternalHalMixerData *next; }; -// Structure to store specific controller hal data -struct CtlHalSpecificData { +// Structure to store specific internal hal data +struct InternalHalData { char *mixerApiName; char *prefix; json_object *halMixerJ; - struct CtlHalMixerData *ctlHalStreamsData; + struct InternalHalMixerData *streamsData; afb_event_t streamUpdates; - struct CtlHalMixerData *ctlHalPlaybacksData; - struct CtlHalMixerData *ctlHalCapturesData; + struct InternalHalMixerData *playbacksData; + struct InternalHalMixerData *capturesData; - struct CtlHalAlsaMapT *ctlHalAlsaMapT; + struct InternalHalAlsaMapT *alsaMapT; afb_api_t apiHandle; CtlConfigT *ctrlConfig; }; -// Structure to store specific hal (controller or external) data -struct SpecificHalData { +// Structure to store specific hal (internal or external) data +struct HalData { char *apiName; enum HalStatus status; char *sndCardPath; @@ -79,9 +79,9 @@ struct SpecificHalData { char *date; // Can be beefed up if needed - struct CtlHalSpecificData *ctlHalSpecificData; // Can be NULL if external api + struct InternalHalData *internalHalData; // Can be NULL if external api - struct SpecificHalData *next; + struct HalData *next; }; // Structure to store hal manager data @@ -91,26 +91,26 @@ struct HalMgrData { afb_api_t apiHandle; - struct SpecificHalData *halDataList; + struct HalData *halDataList; }; -// Specfic Hal controller streams data handling functions -struct CtlHalMixerData *HalUtlAddMixerDataToMixerDataList(struct CtlHalMixerData **mixerDataList); -int8_t HalUtlRemoveSelectedMixerData(struct CtlHalMixerData **mixerDataList, struct CtlHalMixerData *mixerDataToRemove); -int64_t HalUtlRemoveAllMixerData(struct CtlHalMixerData **mixerDataList); -int64_t HalUtlGetNumberOfMixerDataInList(struct CtlHalMixerData **mixerDataList); -struct CtlHalMixerData *HalUtlSearchMixerDataByProperties(struct CtlHalMixerData **mixerDataList, char *verb, char *verbToCall, char *streamCardId); - -// Exported verbs for 'struct SpecificHalData' handling -struct SpecificHalData *HalUtlAddHalApiToHalList(struct SpecificHalData **halDataList); -int8_t HalUtlRemoveSelectedHalFromList(struct SpecificHalData **halDataList, struct SpecificHalData *ApiToRemove); -int64_t HalUtlRemoveAllHalFromList(struct SpecificHalData **halDataList); -int64_t HalUtlGetNumberOfHalInList(struct SpecificHalData **halDataList); -struct SpecificHalData *HalUtlSearchHalDataByApiName(struct SpecificHalData **halDataList, char *apiName); -struct SpecificHalData *HalUtlSearchReadyHalDataByCardId(struct SpecificHalData **halDataList, int cardId); - -// Exported verbs for 'struct HalMgrData' handling -uint8_t HalUtlInitializeHalMgrData(afb_api_t apiHandle, struct HalMgrData *HalMgrGlobalData, char *apiName, char *info); -void HalUtlRemoveHalMgrData(struct HalMgrData *HalMgrGlobalData); +// Internal Hal - Streams data handling functions +struct InternalHalMixerData *HalUtlAddMixerDataToMixerDataList(struct InternalHalMixerData **mixerDataList); +int8_t HalUtlRemoveSelectedMixerData(struct InternalHalMixerData **mixerDataList, struct InternalHalMixerData *mixerDataToRemove); +int64_t HalUtlRemoveAllMixerData(struct InternalHalMixerData **mixerDataList); +int64_t HalUtlGetNumberOfMixerDataInList(struct InternalHalMixerData **mixerDataList); +struct InternalHalMixerData *HalUtlSearchMixerDataByProperties(struct InternalHalMixerData **mixerDataList, char *verb, char *verbToCall, char *streamCardId); + +// Hal data handling functions +struct HalData *HalUtlAddHalToHalList(struct HalData **halDataList); +int8_t HalUtlRemoveSelectedHalFromList(struct HalData **halDataList, struct HalData *halToRemove); +int64_t HalUtlRemoveAllHalFromList(struct HalData **halDataList); +int64_t HalUtlGetNumberOfHalInList(struct HalData **halDataList); +struct HalData *HalUtlSearchHalDataByApiName(struct HalData **halDataList, char *apiName); +struct HalData *HalUtlSearchReadyHalDataByCardId(struct HalData **halDataList, int cardId); + +// Hal Manager data handling functions +uint8_t HalUtlInitializeHalMgrData(afb_api_t apiHandle, struct HalMgrData *halMgrData, char *apiName, char *info); +void HalUtlRemoveHalMgrData(struct HalMgrData *halMgrData); #endif /* _HAL_UTILITIES_DATA_INCLUDE_ */
\ No newline at end of file |