include/lib/sku.h

/**
 * Copyright 2017 The ChromiumOS Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#ifndef MOSYS_LIB_SKU_H__
#define MOSYS_LIB_SKU_H__

struct platform_intf;

/**
 * sku_info - a structure to hold per-SKU information.
 *
 * `brand` is the 4 letter RLZ brand code (go/crosrlz) in upper case, different
 *         for each LOEM in White Label devices, and also used for CR50 BoardID,
 *         for example 'ZZCR'.
 * `model` is the model name (the public code name on Golden Eye Device list)
 *         in lower case, for example 'samus'.
 * `customization` is the legacy support for customization_id in upper case,
 *         for example 'GOOGLE-SAMUS', also used as network config key.
 */
struct sku_info {
	const char *brand;
	const char *model;
	const char *customization;
};

/**
 * sku_get_brand - get (RLZ) brand code
 *
 * returns allocated string containing value if found
 * returns NULL to indicate value not found or error
 */
extern char *sku_get_brand(struct platform_intf *intf);

/**
 * sku_get_customization - get customization ID from model then VPD
 *
 * returns allocated string containing value if found
 * returns NULL to indicate value not found or error
 */
extern char *sku_get_customization(struct platform_intf *intf);

/**
 * sku_get_model - get model name
 *
 * returns allocated string containing value if found
 * returns NULL to indicate value not found or error
 */
extern char *sku_get_model(struct platform_intf *intf);

#endif /* MOSYS_LIB_SKU_H__ */