Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / chromiumos / overlays / chromiumos-overlay / refs/heads/fix_branch / . / eclass / cros-board.eclass
blob: cea6eb9ca5803598d93fefa1df42d0b316f06826 [file] [log] [blame]
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]1# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Taylor Hutt729e9d42011-08-29 10:05:16 -0700[diff] [blame]2# Distributed under the terms of the GNU General Public License v2
3
4#
5# Original Author: The Chromium OS Authors <chromium-os-dev@chromium.org>
6# Purpose: Library for handling building of ChromiumOS packages
7#
8#
9# This class sets the BOARD environment variable. It is intended to
10# be used by ebuild packages that need to have the board information
11# for various reasons -- for example, to differentiate various
12# hardware attributes at build time; see 'adhd' for an example of
13# this.
14#
15# When set, the BOARD environment variable should conform to the
16# syntax used by the CROS utilities.
17#
18# If an unknown board is encountered, this class deliberately fails
19# the build; this provides an easy method of identifying a change to
20# the build which might affect inheriting packages.
21#
22# For example, the ADHD (Google A/V daemon) package relies on the
23# BOARD variable to determine which hardware should be monitored at
24# runtime. If the BOARD variable is not set, the daemon will not
25# monitor any specific hardware; thus, when a new board is added, the
26# ADHD project must be updated.
27#
Matt Tennant8b6b2382011-09-12 17:47:16 -0700[diff] [blame]28[[ ${EAPI} != "4" ]] && die "Only EAPI=4 is supported"
29
Matt Tennanta6aa5452011-09-09 18:40:46 -0700[diff] [blame]30BOARD_USE_PREFIX="board_use_"
Daniel Eratb1b6c3e2013-09-26 16:32:17 -0700[diff] [blame]31
32# Obsolete boards' names are commented-out but retained in this list so
33# they won't be accidentally recycled in the future.
Matt Tennanta6aa5452011-09-09 18:40:46 -0700[diff] [blame]34ALL_BOARDS=(
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]35 amd64-corei7
Gaurav Shah6ec6d8d2014-04-17 17:10:19 -0700[diff] [blame]36 #amd64-drm
37 amd64-generic
38 amd64-generic_embedded
Michael Spangde2270d2014-09-08 13:08:45 -0400[diff] [blame]39 amd64-generic_freon
Prathmesh Prabhu8f8fc732014-10-08 18:02:03 -0700[diff] [blame]40 amd64-generic_mobbuild
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]41 amd64-host
Kevin Chengbe34e202014-02-24 13:10:47 +0800[diff] [blame]42 anglar
Daniel Eratfb4d75f2014-07-23 14:20:47 -0700[diff] [blame]43 #app-shell-panther
Jay (Yong Jae) Kimcba101d2012-12-07 17:14:02 -0800[diff] [blame]44 aries
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]45 arm-generic
Michael Spangde2270d2014-09-08 13:08:45 -0400[diff] [blame]46 arm-generic_freon
Olof Johansson44cbd8e2014-02-10 14:09:20 -0800[diff] [blame]47 arm64-generic
Bernie Thompson606a3532014-08-13 14:23:16 -0700[diff] [blame]48 auron
Kevin Cheng62d31602014-09-09 14:55:19 +0800[diff] [blame]49 auron_paine
Kane Chenfff2a692014-10-13 16:03:27 +0800[diff] [blame]50 auron_pearlvalley
Kevin Cheng62d31602014-09-09 14:55:19 +0800[diff] [blame]51 auron_yuna
Josh Triplett6513a0f2013-08-19 13:31:42 -0700[diff] [blame]52 bayleybay
Liam McLoughlin19107c42012-07-02 16:39:33 -0700[diff] [blame]53 beaglebone
Albert Chaulk94bc7f52013-12-17 19:21:40 -0800[diff] [blame]54 beaglebone_servo
Mohammed Habibulla86fd34f2013-08-21 11:25:08 -0700[diff] [blame]55 beltino
Chris Wolfefc7be402013-05-30 12:42:52 -0400[diff] [blame]56 blackwall
Steve Funga459cc22014-07-25 17:24:47 -0700[diff] [blame]57 bobcat
Duncan Laurie5acfe202013-06-24 09:43:19 -0700[diff] [blame]58 bolt
Shawn Nematbakhsh81bab192012-06-18 11:05:31 -0700[diff] [blame]59 butterfly
Joe Konnoaabb02f2014-03-04 13:54:41 -0800[diff] [blame]60 bwtm2
Huang, Huki83352a12014-08-04 15:11:28 +0800[diff] [blame]61 candy
Yung Leem21831402013-08-23 16:27:47 -0700[diff] [blame]62 cardhu
Daniel Erat1f5cdc22013-09-27 09:05:14 -0700[diff] [blame]63 #chronos
Gene Chen5b3825a2013-12-10 19:29:38 +0800[diff] [blame]64 clapper
Vadim Bendebury1763d042014-10-01 18:41:36 -0700[diff] [blame]65 cosmos
Bernie Thompsondb407e12014-07-24 18:10:43 -0700[diff] [blame]66 cranky
Katie Roberts-Hoffman452bf602012-02-23 13:19:44 -0800[diff] [blame]67 daisy
Michael Spang2b735582014-08-25 19:48:11 -0400[diff] [blame]68 daisy_freon
Gaurav Shah6ec6d8d2014-04-17 17:10:19 -0700[diff] [blame]69 #daisy-drm
70 daisy_embedded
Bernie Thompson7bcd9e22012-11-15 13:21:30 -0800[diff] [blame]71 daisy_snow
Katie Roberts-Hoffman31138342013-12-20 16:35:27 -0800[diff] [blame]72 daisy_skate
73 daisy_spring
Scott James Remnant95d10fb2013-10-31 17:07:21 -0700[diff] [blame]74 daisy_winter
Andrew Chew351e22a2013-02-12 11:08:48 -0800[diff] [blame]75 dalmore
Gaurav Shahb48d4bf2013-11-27 18:30:52 -0800[diff] [blame]76 duck
Daniel Eratb1b6c3e2013-09-26 16:32:17 -0700[diff] [blame]77 #emeraldlake2
Bernie Thompson55af4792014-03-11 15:18:56 -0700[diff] [blame]78 enguarde
Bernie Thompsonc258e032014-03-19 17:21:53 -0700[diff] [blame]79 expresso
Jay (Yong Jae) Kim596bed12013-04-25 14:55:24 -0700[diff] [blame]80 falco
Brian J Lovin43d61c42014-09-26 13:59:01 -0700[diff] [blame]81 falco_freon
Chad Versaced10c8ce2014-04-17 15:48:44 -0700[diff] [blame]82 falco_gles
Jay (Yong Jae) Kim521bd0e2014-02-06 13:15:00 -0800[diff] [blame]83 falco_li
Josh Triplettacf58252012-07-26 10:51:53 -0700[diff] [blame]84 fb1
Duncan Laurief71e41b2013-03-01 13:49:10 -0800[diff] [blame]85 fox
86 fox_baskingridge
87 fox_wtm1
88 fox_wtm2
Chris Sosacb50f042014-02-04 17:49:27 -0800[diff] [blame]89 gizmo
Kevin Cheng24ed2892013-12-12 13:52:11 +0800[diff] [blame]90 glimmer
Bernie Thompson77963002014-03-19 17:18:48 -0700[diff] [blame]91 gnawty
James Ausmus10348792014-04-25 10:47:58 -0700[diff] [blame]92 hsb
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]93 ironhide
Nam T. Nguyen8e077942014-09-02 14:13:43 -0700[diff] [blame]94 kayle
Daniel Erat1f5cdc22013-09-27 09:05:14 -0700[diff] [blame]95 #kiev
Bernie Thompsond0a3d252014-02-24 19:47:00 -0800[diff] [blame]96 kip
Jay Kim84088ef2012-04-09 16:50:17 -0700[diff] [blame]97 klang
Frank Hodd2a0162014-06-13 17:31:44 +0800[diff] [blame]98 laser
Bertrand SIMONNETa06cfbb2014-03-19 17:02:10 -0700[diff] [blame]99 lemmings
Nam T. Nguyene0735442014-04-15 10:23:18 -0700[diff] [blame]100 lemmings_external
Yung Leem21831402013-08-23 16:27:47 -0700[diff] [blame]101 leon
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]102 link
Michael Spang2ba67782014-04-11 18:56:12 -0400[diff] [blame]103 link_freon
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]104 lumpy
Daniel Eratfb4d75f2014-07-23 14:20:47 -0700[diff] [blame]105 mappy
Daniel Erat76e7c892014-11-03 18:48:04 -0700[diff] [blame]106 mappy-envoy
Daniel Erat924b7852014-07-31 10:06:19 -0700[diff] [blame]107 mappy_flashstation
Gaurav Shah3a16bc92014-04-28 17:15:25 -0700[diff] [blame]108 marble
Shan-Fu Chiou49ba7072014-05-05 11:10:05 +0800[diff] [blame]109 mccloud
Ronald Claveaub2c33c32014-05-13 09:44:15 +0200[diff] [blame]110 minnowboard
Mike Frysinger0bc02aa2013-10-19 03:34:54 -0400[diff] [blame]111 mipseb-o32-generic
112 mipseb-n32-generic
113 mipseb-n64-generic
114 mipsel-o32-generic
115 mipsel-n32-generic
116 mipsel-n64-generic
bowgotsai2d3d0752013-10-24 23:08:57 +0800[diff] [blame]117 monroe
Nathan Chung1e9af862014-06-11 02:33:45 -0400[diff] [blame]118 moose
Andrew Chewc15680b2013-07-30 14:22:22 -0700[diff] [blame]119 nyan
Katie Roberts-Hoffmane76e2c12013-12-20 21:25:54 -0800[diff] [blame]120 nyan_big
Andrew Chewf1fd3092014-02-06 18:34:38 -0800[diff] [blame]121 nyan_blaze
Stéphane Marchesin72ccafa2014-06-11 20:27:14 -0700[diff] [blame]122 nyan_freon
Penny Chiuede8b852014-08-08 18:40:20 +0800[diff] [blame]123 nyan_kitty
Gaurav Shah99f711f942013-11-27 18:27:51 -0800[diff] [blame]124 optimus
Anush Elangovane98b4522012-04-25 17:34:36 -0700[diff] [blame]125 panda
bowgotsaia064c6e2013-10-16 17:24:34 +0800[diff] [blame]126 panther
Steve Fung3f9af002014-05-05 13:26:50 -0700[diff] [blame]127 panther_embedded
Pawel Osciak254c8212014-10-28 15:29:25 +0900[diff] [blame]128 panther_freon
Ricky Liang8327e592014-08-20 11:10:54 +0800[diff] [blame]129 panther_goofy
Prathmesh Prabhu790b2f42014-10-08 18:04:27 -0700[diff] [blame]130 panther_moblab
Jay Kimb2152e82012-05-22 20:37:09 -0700[diff] [blame]131 parrot
Mohammed Habibullad5c704c2013-11-26 16:10:26 -0800[diff] [blame]132 parrot_ivb
Mohammed Habibullac85eb662013-07-09 14:44:56 -0700[diff] [blame]133 parrot32
134 parrot64
Kaiyen Chang01c2dfb2014-09-26 15:47:12 +0800[diff] [blame]135 parry
Katie Roberts-Hoffman1b3abf62013-03-15 16:45:10 -0700[diff] [blame]136 peach
Katie Roberts-Hoffman57d2b832013-07-30 14:21:03 -0700[diff] [blame]137 peach_kirby
Katie Roberts-Hoffmanc8be3b12013-12-10 09:24:56 -0800[diff] [blame]138 peach_pi
Doug Anderson506ffec2013-03-20 13:10:07 -0700[diff] [blame]139 peach_pit
Dave Parker35df9ae2013-04-23 11:09:01 -0700[diff] [blame]140 peppy
Haixia Shi282c9192014-10-28 16:11:44 -0700[diff] [blame]141 peppy_freon
Mike Frysinger0bc02aa2013-10-19 03:34:54 -0400[diff] [blame]142 ppcbe-32-generic
143 ppcbe-64-generic
144 ppcle-32-generic
145 ppcle-64-generic
Allen Martin68bdb4e2012-11-08 15:44:41 -0800[diff] [blame]146 puppy
Bernie Thompson9c5c0692014-02-24 19:45:32 -0800[diff] [blame]147 quawks
Bernie Thompson520fa1f2013-10-04 16:51:53 -0700[diff] [blame]148 rambi
Liam McLoughlin81d0a492012-05-17 17:38:47 +0100[diff] [blame]149 raspberrypi
Daniel Erat1f5cdc22013-09-27 09:05:14 -0700[diff] [blame]150 #ricochet
Gaurav Shah25115942013-11-27 18:29:11 -0800[diff] [blame]151 rizer
Olof Johansson44cbd8e2014-02-10 14:09:20 -0800[diff] [blame]152 rush
Aaron Durbin09636f72014-07-14 17:57:35 -0500[diff] [blame]153 rush_ryu
Mohammed Habibulla4591aaf2013-08-28 13:29:13 -0700[diff] [blame]154 samus
Jay (Yong Jae) Kim330a3822013-04-22 15:26:25 -0700[diff] [blame]155 slippy
Chris Masone58b2a1e2013-03-19 14:55:21 -0700[diff] [blame]156 sonic
Bernie Thompson02db6672013-10-17 15:23:38 -0700[diff] [blame]157 squawks
Gaurav Shahd1226b02014-03-18 14:34:23 -0700[diff] [blame]158 storm
Shawn Nematbakhsh81bab192012-06-18 11:05:31 -0700[diff] [blame]159 stout
Mike Frysingerb6d67942014-04-28 17:40:41 -0400[diff] [blame]160 #stout32
Brian J Lovin8e4d65a2014-07-01 16:08:23 -0700[diff] [blame]161 strago
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]162 stumpy
Jay (Yong Jae) Kima4f64782013-12-09 16:18:28 -0800[diff] [blame]163 stumpy_moblab
Mike Frysinger65a3704e2013-04-12 18:19:11 -0400[diff] [blame]164 stumpy_pico
Bernie Thompson3cab0ec2014-03-11 15:21:04 -0700[diff] [blame]165 swanky
Steve Fung79db4482014-02-19 17:26:28 -0800[diff] [blame]166 tails
Daniel Eratb1b6c3e2013-09-26 16:32:17 -0700[diff] [blame]167 #tegra2
168 #tegra2_aebl
169 #tegra2_arthur
170 #tegra2_asymptote
171 #tegra2_dev-board
172 #tegra2_dev-board-opengl
173 #tegra2_kaen
174 #tegra2_seaboard
175 #tegra2_wario
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]176 tegra3-generic
Mohammed Habibullaf9ea7ff2014-04-28 11:30:51 -0700[diff] [blame]177 tricky
Gaurav Shahae1baa12014-07-18 18:36:16 -0700[diff] [blame]178 urara
Katie Roberts-Hoffmance9d7d92014-05-16 12:59:09 -0700[diff] [blame]179 veyron
Katie Roberts-Hoffman31ce4f52014-10-23 15:46:39 -0700[diff] [blame]180 veyron_jerry
181 veyron_mighty
182 veyron_minnie
Katie Roberts-Hoffman8d008322014-08-18 15:29:55 -0700[diff] [blame]183 veyron_pinky
Katie Roberts-Hoffman31ce4f52014-10-23 15:46:39 -0700[diff] [blame]184 veyron_remy
185 veyron_speedy
Daniel Eratb1b6c3e2013-09-26 16:32:17 -0700[diff] [blame]186 #waluigi
Gaurav Shah5d390372014-10-23 10:35:47 -0700[diff] [blame]187 whirlwind
Dave Parkerc9611812014-01-22 02:00:29 +0800[diff] [blame]188 winky
Mohammed Habibullae8283fd2013-07-16 15:45:47 -0700[diff] [blame]189 wolf
James Ausmus10348792014-04-25 10:47:58 -0700[diff] [blame]190 wsb
Mike Frysinger2cd338d2012-12-01 15:05:58 -0500[diff] [blame]191 x32-generic
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]192 x86-agz
193 x86-alex
194 x86-alex_he
Micah Catlin10dcede2012-03-19 19:00:36 -0700[diff] [blame]195 x86-alex_hubble
Sonny Raoe8abf8d2012-04-20 23:00:51 +0000[diff] [blame]196 x86-alex32
David James39504472012-04-20 18:41:00 -0700[diff] [blame]197 x86-alex32_he
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]198 x86-dogfood
Gaurav Shah6ec6d8d2014-04-17 17:10:19 -0700[diff] [blame]199 #x86-drm
Daniel Eratb1b6c3e2013-09-26 16:32:17 -0700[diff] [blame]200 #x86-fruitloop
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]201 x86-generic
Gaurav Shah6ec6d8d2014-04-17 17:10:19 -0700[diff] [blame]202 x86-generic_embedded
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]203 x86-mario
204 x86-mario64
Daniel Eratb1b6c3e2013-09-26 16:32:17 -0700[diff] [blame]205 #x86-pineview
206 #x86-wayland
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]207 x86-zgb
208 x86-zgb_he
Sonny Raoe8abf8d2012-04-20 23:00:51 +0000[diff] [blame]209 x86-zgb32
David James39504472012-04-20 18:41:00 -0700[diff] [blame]210 x86-zgb32_he
Gediminas Ramanauskasdec45472013-12-19 11:26:40 -0800[diff] [blame]211 zako
Matt Tennanta6aa5452011-09-09 18:40:46 -0700[diff] [blame]212)
213
Matt Tennant8b6b2382011-09-12 17:47:16 -0700[diff] [blame]214# Add BOARD_USE_PREFIX to each board in ALL_BOARDS to create IUSE.
Mike Frysinger169f0402012-02-13 14:35:15 -0500[diff] [blame]215# Also add cros_host so that we can inherit this eclass in ebuilds
216# that get emerged both in the cros-sdk and for target boards.
217# See REQUIRED_USE below.
218IUSE="${ALL_BOARDS[@]/#/${BOARD_USE_PREFIX}} cros_host"
Taylor Hutt729e9d42011-08-29 10:05:16 -0700[diff] [blame]219
Matt Tennant8b6b2382011-09-12 17:47:16 -0700[diff] [blame]220# Require one, and only one, of the board_use flags to be set if this eclass
221# is used. This effectively makes any ebuild that inherits this eclass require
222# a known valid board to be set.
223REQUIRED_USE="^^ ( ${IUSE} )"
224
225# Echo the current board, with variant.
226get_current_board_with_variant()
Taylor Hutt729e9d42011-08-29 10:05:16 -0700[diff] [blame]227{
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]228 local b
Taylor Hutt729e9d42011-08-29 10:05:16 -0700[diff] [blame]229
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]230 for b in "${ALL_BOARDS[@]}"; do
231 if use ${BOARD_USE_PREFIX}${b}; then
232 echo ${b}
233 return
234 fi
235 done
Matt Tennanta6aa5452011-09-09 18:40:46 -0700[diff] [blame]236
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]237 die "Unable to determine current board (with variant)."
Matt Tennant8b6b2382011-09-12 17:47:16 -0700[diff] [blame]238}
239
240# Echo the current board, without variant.
241get_current_board_no_variant()
242{
Mike Frysinger274d83f2012-02-09 14:13:40 -0500[diff] [blame]243 get_current_board_with_variant | cut -d '_' -f 1
Taylor Hutt729e9d42011-08-29 10:05:16 -0700[diff] [blame]244}